Refund Payment

post

/2.0/payment/refund

Request a refund for a one-time or subscription payment, either in full or partial

Example Request

preparing...

Usage Notes

Refunds are not immediate, and will be reviewed and approved by our buyer support team.

Request

Body

vendor_id

integer

required

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

>= 1

vendor_auth_code

string

required

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

Match pattern:

[0-9a-f]+

order_id

string

required

The order ID of the payment you wish to refund. NB. Subscription orders are hyphenated and one-time orders are an integer.

Match pattern:

\d+(\-\d+)?

amount

number

Partial amount to refund in the currency of the order. The full payment is refunded if this parameter is not provided.

reason

string

Reason for providing the refund. This will be displayed in the Seller Dashboard.

<= 255 characters

Body