POST Retrieve Refund Eligibility
The POST Retrieve Refund Eligibility method allows you to check if a specific transaction is eligible for a refund. Refund eligibility is determined by the following criteria:
- The transaction must be successfully processed and settled at least two days prior to the refund request.
- The transaction must be of type SALE.
- The transaction status must not be Authorized, Chargeback, Declined or Failed.
- The transaction must not be part of a batch that is yet to be processed.
- The transaction must not be in the MPIPD/MPIPI payment category.
- The transaction must not be processed with Commerce Bank.
- The transaction is not eligible if the transaction status is refunded and the total refund amount is equal to the Total capture amount of the transaction.
- The transaction is not eligible if the transaction status is refunded and there is a refund event on the transaction in the previous 24 hours.
| API Endpoint |
| https://api.uat.anddone.com/secure/refunds/eligibility |
| API Data | Details |
| URI | secure/refunds/eligibility |
| 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
Body Response Example (JSON) - Transaction Cannot Be Refunded
Body Response Example - Transaction Eligible for Refund
{"refundEligible":true,"message":null}