Initiate a refund for a given successful payment request.
The XenPlatform subaccount user id that will perform this transaction.
{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"currency": "IDR",
"amount": 10000,
"reason": "REQUESTED_BY_CUSTOMER"
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"reason": "REQUESTED_BY_CUSTOMER"
}Create refund API request body
Xendit unique Payment Request ID generated as reference after creation of payment request.
A Reference ID from merchants to identify their request.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be refunded to the end user.
Status of the refund.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Refund is pending. Check the final status of the refund via webhook.
Refund object
Xendit unique Refund ID generated as reference after creation of refund.
Xendit unique Payment Request ID generated as reference after creation of payment request.
To be deprecated. Xendit unique Payment ID generated as reference for a payment.
To be deprecated. Xendit unique Invoice ID generated as reference after creation of an invoice or payment link.
To be deprecated. Type of the payment method used in the original payment.'
A Reference ID from merchants to identify their request.
Channel code used to select the payment method provider. Use routing payment channels mapping for full list of channel codes.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be refunded to the end user.
Status of the refund.
Status of the refund.
Reasons of the refund failure.
Fee for processing the refund
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
ISO 8601 date-time format.
ISO 8601 date-time format.
Bad request
Values in the payment request is not within expected range or expected configurations. Check the specific error message for debugging.
Fields or values in the payment request does not comply with our API specification. Check the specific error message for debugging.
Refund amount specified in refund request must be less than or equal to unrefunded capture amount.
Requested feature is unavailable during this timing.
Please wait for the pending refund request to be completed before initiating a new one.
Feature is not allowed for the payment request because of its current status. Check the specific error message for debugging.
There is insufficient balance in your account to perform a refund. Please top up your balance with a sufficient amount before retrying the refund.
Number of partial refunds for this payment request has exceeded what is allowed by payment channel. Please check our documentations for refund limitations.
Forbidden
Non 3DS payment request for cards is not allowed. Please activate the feature on Xendit dashboard before proceeding.
Merchant credentials met with an error with the provider. Please contact Xendit customer support to resolve this issue.
Refund feature is not available for this payment channel.
Partial Refund feature is not available for this payment channel.
Not found
ID specified in request cannot be found.
Internal server error
An unexpected error occured, our team has been notified and will troubleshoot the issue
Service unavailable
The channel requested is currently experiencing unexpected issues. The provider will be notified to resolve this issue.