POST Secure Refund Payment Request
The POST Secure Refund Payment Request method is used by the merchant to submit a refund payment request against an eligible payment transaction.
The POST Secure Refund Payment Request method is used by the merchant to submit a refund payment request against an eligible payment transaction.
Note: This API currently supports refunds of the total payment transaction amount only. Partial amount refunds are not supported.
If successful, the POST Secure Refund Payment method returns:
- The
transactionID,traceNumberandrefundReferenceassociated with the refund payment. - The details of the original payment transaction, including payment method, billing contact, amount and the payment transaction ID
referenceTransactionID.
If the refund request is unsuccessful, the POST Secure Refund Payment returns a message indicating the reason that the refund request was not completed.
Webhook Notifications: This API supports webhook notifications for real-time tracking of refund requests. To receive notifications, subscribe to the Refund webhook module in the AndDone Merchant Portal. For detailed payload and event information, see Refund Webhook Payloads.
| API Endpoint |
| https://api.uat.anddone.com/secure/refunds |
| API Data | Details |
| URI | secure/refunds |
| Method | POST |
| Authorization | API Key Authorization |
| Authorization | |
| x-api-key | API key {env_merchantAccessKey} |
| Request Headers | |
| x-app-key | Merchant ID or App Key {env_merchantId} |
| x-version | API version (e.g., 2.1). If no version is specified, the call will default to version 2.0 of the API. |
| Origin | URL or IP address provided to AndDone as an allowed origin. |
| Content-Type | application/json |
Request Parameters
| Field Name | Data Type | Mandatory | Field Length | Description |
Body Request Example (JSON)
Response Parameters
| Authorization | |
| Key | key |
| Value | {{env_merchantAccessKey}} |
| Request Headers | |
| x-app-key | {{env_merchantId}} |
Body Response Example (JSON)