Order Details
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Plans
Users
Modifiers
Payments
One-off Charges
Webhooks
post

/2.0/payment/refund

Request a refund for a one-time or subscription payment, either in full or partial. Note that refunds are not immediate and will be reviewed and approved by our buyer support team.

Request Body

Form data (application/x-www-form-urlencoded)
vendor_id
integer

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

required
minimum: 1
pattern: \d+
vendor_auth_code
string

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.

required
pattern: [0-9a-f]+
order_id
string

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

required
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.

pattern: \d+(\.\d{2})?
reason
string

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

maxLength: 255

Responses

1 Example
Schema
object
or
object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.