WebsiteStatusSupport
API reference
Sign up

Debit

post
https://yourdomain.com/partner/v1/debit

Initial debit request sent from the Partner API to the Payment Service Provider.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 32 and 32

The unique transaction ID provided by Peach Payments.

configuration
object
required

Authentication configuration details required by the Partner API.

string
required
length between 4 and 13

The payment request amount.

string
required
length between 3 and 3

The currency code of the payment request's amount.

string
required
length between 1 and 32

The payment brand specifies the method of payment for the request.

string
enum
required

Payment type of the transaction.

Allowed:
customer
object

Optional object sent if partner requires customer data.

customParameters
object

A JSON object depicting custom information sent by the merchant and Peach. Must be echoed back in the response.

string
length between 1 and 255

Merchant-provided reference number, often used for reconciliation.

string
required
length between 1 and 255

The merchant's name.

string
length between 8 and 255

The merchant's invoice ID.

uri
required

The Peach-provided URL to which the partner is required to send notifications or webhooks when the transaction status is updated.

string
length between 1 and 32

Session ID of the transaction, provided by the partner.

uri
required

The Payment Service Provider must redirect the user to this URL after processing the payment request.

card
object

The card data structure holds all information regarding a credit or debit card account.

billing
object

Optional object that can be used for billing or shipping information.

shipping
object

Optional object that can be used for billing or shipping information.

date-time
required

The timestamp of the transaction.

cart
object

Customer cart data.

Responses

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago