WebsiteStatusSupport
API reference
Sign up

Cancel

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

Cancel transaction 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…
Path Params
string
required
length between 32 and 32
^[0-9a-f]{32}$

The Peach unique ID of the transaction to be cancelled.

Body Params
configuration
object
required

Authentication configuration details required by the Partner API.

string
required
length between 1 and 32
^[a-zA-Z0-9_]{1,32}$

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

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
^[\s\S]{1,255}$

Merchant-provided reference number, often used for reconciliation.

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
^[\s\S]{1,32}$

Session ID of the transaction, provided by the partner.

date-time
required

The timestamp of the transaction.

Responses

Updated 11 months ago

Did this page help you?
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 11 months ago

Did this page help you?