WebsiteStatusSupport
API reference
Sign up

Refund

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

Refund 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 original debit transaction.

Body Params
string
required
length between 32 and 32
^[0-9a-f]{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
(?!0+\.00)^\d{1,10}\.\d{2}$

The payment request amount.

string
required
length between 3 and 3
^[A-Z]{3}$

The currency code of the payment request's amount.

string
required
length between 1 and 32
^[a-zA-Z0-9_]{1,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.

uri
required

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

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?