refund

2024-08-29 06:58

POST /v1/payments/refund

Use this API to initiate a refund against a successful payment. The refund can be full or partial. A transaction can have multiple refunds as long as the total refund amount is less than or equal to the original transaction amount. If the refund request is out of the refund window determined in the contract, the refund request will be declined.

Note: Use the same refundRequestId field to retry a refund in case of timeout or when the returned resultStatus is U. The refundRequestId field is designed to be idempotent.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：

Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:

If the data type of a field is Integer and its value is 20, set it as "20".
If the data type of a field is Boolean and its value is true, set it as "true".

Request parameters

refundRequestId String REQUIRED

The unique ID assigned by the merchant to identify a refund request.

More information:

This field is an API idempotency field.The merchant uses the refundRequestId field for idempotency control. For payment requests that are initiated with the same value of refundRequestId and reach a final status (S or F), the same result is to be returned for the request.
Maximum length: 64 characters

paymentId String REQUIRED

The unique ID assigned by Antom for the original payment to be refunded.

More information:

Maximum length: 64 characters

referenceRefundId String

The unique ID to identify a refund, which is assigned by the merchant that directly provides services or goods to the customer.

Note: Specify this field if this value is needed for internal use or reconciliation.

More information:

Maximum length: 64 characters

refundAmount Amount REQUIRED

The refund amount that is initiated by the merchant.

Show child parameters

refundReason String

The refund reason.

Note: Specify this field if you want to provide the refund reason to the user and payment method.

More information:

Maximum length: 256 characters

refundNotifyUrl String

The URL that is used to receive the refund result notification. The URL must be either specified in the request or set in Antom Dashboard.

Note: Specify this field if you want to receive an asynchronous notification of the refund result. If the refund notification URL is specified in both the request and Antom Dashboard, the value specified in the request takes precedence.

More information:

Maximum length: 1024 characters

passThroughMetadata String

A set of key-value pairs that indicate your additional and custom information about the transaction.

Note: Specify this parameter if you want to provide more information about the transaction to your acquirer.

More information:

Maximum length: 2048 characters

Response parameters

result Result REQUIRED

Indicates whether this API is called successfully. If this API is successfully called, the refund succeeds.

Show child parameters

refundRequestId String

The unique ID that is assigned by the merchant to identify a refund request.

Note: This field is returned when the refund succeeds (the value of result.resultStatus is S).

More information:

Maximum length: 64 characters

refundId String

The unique ID that is assigned by Antom to identify a refund. A one-to-one correspondence between refundId and refundRequestId exists.

Note: This field is returned when the refund succeeds (the value of result.resultStatus is S).

More information:

Maximum length: 64 characters

paymentId String

The unique ID assigned by Antom for the original payment to be refunded.

Note: This field is returned when the refund succeeds (the value of result.resultStatus is S).

More information:

Maximum length: 64 characters

acquirerReferenceNo String

The unique ID assigned by the non-Antom acquirer for the transaction.

More information:

Maximum length: 64 characters

refundAmount Amount

The refund amount collected by the payer for this refund.

Note: This field is returned when the refund succeeds (the value of result.resultStatus is S).

Show child parameters

refundTime Datetime

The date and time when the refund reaches the state of success, failure, or unknown.

More information:

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

grossSettlementAmount Amount

The refund settlement amount, which equals the refund amount multiplied by the value of settlementQuote.

Note: This field is returned when the currency exchange is predetermined and the exchange rate is locked at the time of the transaction.

Show child parameters

settlementQuote Quote

The exchange rate between the settlement currency and transaction currency.

Note: This field is returned when grossSettlementAmount is returned.

Show child parameters

acquirerInfo AcquirerInfo

The information of the acquirer that processes the payment.

Note: This parameter is returned if you integrate the APO product.

Show child parameters

API Explorer

Sample CodesRun in Sandbox

Request

URL

Request Body

Response

Case

Success

Response Body

Result process logic

For different request results, different actions are to be performed. See the following list for details:

If the value of result.resultStatus is S, the refund succeeds.
If the value of result.resultStatus is F, the refund fails. Usually, the failure reason is that the refund is initiated when the refund window has passed (result.resultCode=REFUND_WINDOW_EXCEED). If the refund still needs to be processed, manual intervention is needed.
If the value of result.resultStatus is U, the result is unknown. Processing failure might occur due to system or network issues. Retry with the same refundRequestId or use the inquiryRefund API to check the refund result.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success	The refund is successful, no further action is needed.
ACCESS_DENIED	F	Access is denied.	Contact Antom Technical Support for detailed reasons.
INVALID_API	F	The called API is invalid or not active.	Contact Antom Technical Support to resolve the issue.
CURRENCY_NOT_SUPPORT	F	The currency is not supported.	Contact Antom Technical Support for detailed reasons.
INVALID_MERCHANT_STATUS	F	The merchant status is abnormal because restrictions exist.	Contact Antom Technical Support for detailed reasons.
KEY_NOT_FOUND	F	The private key or public key of Antom or the merchant is not found.	Check whether the private key or public key exists. If not, upload the private key in Antom Developer Center.
MERCHANT_BALANCE_NOT_ENOUGH	F	The merchant balance is insufficient.	Call the API again after the merchant has sufficient balance. The refundRequestId field needs to be changed when you try again.
MULTIPLE_REFUNDS_NOT_SUPPORTED	F	Multiple refunds are not supported because restrictions exist in the contract.	Check whether multiple refunds exist. Do not call the refund interface anymore. For each refund, only call the API once.
NO_INTERFACE_DEF	F	API is not defined.	Check whether the URL is correct. Please refer to the endpoint in the API documentation.
ORDER_IS_CLOSED	F	The request you initiated has the same paymentRequestId as that of the existed transaction, which is closed.	Use a new paymentRequestId to initiate the refund again.
ORDER_NOT_EXIST	F	The order does not exist.	Check whether paymentId is correct. If correct, contact Antom Technical Support for specific reasons.
ORDER_STATUS_INVALID	F	The order status is invalid. The transaction is under process or the transaction is failed.	Check the order status and take corresponding actions. Wait if the transaction is under process. Do not initiate the refund if the transaction failed. Contact Antom Technical Support for specific reasons.
PARAM_ILLEGAL	F	The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong.	Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid.
PROCESS_FAIL	F	A general business failure occurred.	Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue.
REFUND_AMOUNT_EXCEED	F	The total refund amount exceeds the payment amount.	Confirm whether the total refund amount exceeds the payment amount. Create a new refund by using an amount less than or equal to the payment amount, or contact Antom Technical Support.
REFUND_WINDOW_EXCEED	F	The refund date exceeds the refundable period that is agreed in the contract.	Confirm whether the refund date exceeds the refundable period. Check the refundable period in the contract or contact Antom Technical Support for the specific refundable period.
REPEAT_REQ_INCONSISTENT	F	The amount or currency is different from the previous request.	Ensure all the fields in the requests are the same or use a new paymentRequestId to initiate the refund again.
SYSTEM_ERROR	F	A system error occurred.	Do not retry, and contact Antom Technical Support for more details.
REFUND_IN_PROCESS	U	The refund is being processed.	Wait for the asynchronous notification or call the inquiryRefund API to query the final refund status. Do not retry the refund request.
REFUND_NOT_SUPPORTED	F	Refunds are not supported for this transaction.	Check the transaction status and the refund policy in the contract. If the transaction is successful and the contract allows refunds, contact Antom Technical Support.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the API again to resolve the issue. If not resolved, contact Antom Technical Support.
PARTIAL_REFUND_NOT_SUPPORTED	F	A partial refund is not supported for this transaction.	Make a full refund or contact the buyer for an offline refund.
PAYMENT_METHOD_NOT_SUPPORTED	F	The payment method does not support canceling or refunding transactions if the payment status is successful.	Do not retry. Contact Antom Technical Support to get more information.
ORDER_IS_CANCELED	F	The transaction is canceled.	You cannot refund the transaction because it is canceled.
UNKNOWN_EXCEPTION	U	An API call has failed, which is caused by unknown reasons.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.