Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

capture

POST /v1/payments/capture

This API is used to capture the funds of an authorized payment from a user's account, and then transfer the specified payment amount to the merchant's account. Depending on different scenarios, the authorized payment can be captured in one of the following ways: 

  • Full capture: Capture the total payment amount. 
  • Partial capture: Capture the partial payment amount.  

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

captureRequestId String  REQUIRED

The unique ID that is assigned by the merchant to identify a capture request. Antom uses this field for idempotence control.  

More information:

  • This field is an API idempotency field.For capture requests that are initiated with the same value of captureRequestId 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 that is assigned by Antom to identify a payment.  

More information:

  • Maximum length: 64 characters

captureAmount Amount  REQUIRED

The capture amount that the merchant requests to receive in the transaction currency.

Show child parameters

Response parameters

result Result  REQUIRED

The result of the API call. 

Show child parameters

captureRequestId String  

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

Note: This parameter is returned when the capture status is successful.

More information:

  • Maximum length: 64 characters

captureId String  

The unique ID that is assigned by Antom to identify a capture.

Note: This parameter is returned when the capture status is successful.

More information:

  • Maximum length: 64 characters

paymentId String  

The unique ID that is assigned by Antom to identify a payment.

Note: This parameter is returned when the capture status is successful.

More information:

  • Maximum length: 64 characters

captureAmount Amount  

The capture amount that the merchant requests to receive in the transaction currency.

Note: This parameter is returned when the capture status is successful.

Show child parameters

captureTime Datetime  

The time when Antom captures the payment. 

Note: This parameter is returned when the capture status is successful.

More information:

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

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

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

The capture is successful, no further action is needed.  

ACCESS_DENIEDFThe access is denied.

Contact Antom Technical Support for detailed reasons.  

AUTH_CANCELLEDFThe payment authorization is canceled.

Use a new paymentRequestId to initiate a payment. 

AUTH_EXPIREDFThe payment authorization is expired.

Use a new paymentRequestId to initiate a payment. 

AUTH_NOT_FOUNDFThe payment authorization is not found.

Contact Alipay Technical Support for detailed reasons.  

CAPTURE_AMOUNT_EXCEED_AUTH_LIMITFThe total capture amount exceeds the limit of the authorized payment amount.

Create a new capture request by using an amount less than or equal to the authorized payment amount, or contact Antom Technical Support. 

CAPTURE_IN_PROCESSUThe capture is processing.

Wait for the notification from Antom or inquiry about the capture result.  

CURRENCY_NOT_SUPPORTFThe currency is not supported.

Check the currency used in the request, such as the capture currency. If the issue persists, contact Alipay Technical Support for detailed reasons.  

MULTI_CAPTURE_NOT_SUPPORTEDFThe transaction does not support multiple captures.

Contact Antom Technical Support for detailed reasons.  

INVALID_CONTRACTFThe parameter values in the contract do not match those in the current transaction.

Check whether the parameter values in the contract match those in the current transaction. If the values match, contact Antom Technical Support to troubleshoot the issue.  

NO_PAY_OPTIONSFNo payment methods are available.

Contact Antom Technical Support for detailed reasons.  

ORDER_IS_CANCELEDFThe transaction is canceled.

Use a new paymentRequestId to initiate a payment.  

ORDER_STATUS_INVALIDFThe transaction status is abnormal. The payment cannot be captured.

Check the transaction status. If the values match, contact Antom Technical Support to troubleshoot the issue.  

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

PAYMENT_COUNT_EXCEED_LIMITFThe number of captures exceeds the limit that is specified by the payment method.

Contact Antom Technical Support to know the specific limit.  

PROCESS_FAILFThe capture failed.

Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue. 

REPEAT_REQ_INCONSISTENTFThe submitted request exists, and the parameter values of this request are not consistent with those of the existing request.

Ensure all the fields in the requests are the same or use a new paymentRequestId to initiate a payment.  

RISK_REJECTFThe request is rejected because of risk control.

Prompt the user that the request is rejected because of failed risk control. 

USER_AMOUNT_EXCEED_LIMITFThe capture amount exceeds the user payment limit.

Create a new capture by using an amount less than or equal to the user payment limit, or contact the user or the issuing bank. 

USER_BALANCE_NOT_ENOUGHFThe user's balance is insufficient for the capture.

Contact Antom Technical Support for detailed reasons.  

USER_NOT_EXISTFThe user's account does not exist on the payment method side.

Contact the user or the issuing bank. 

USER_STATUS_ABNORMALFThe user's account status is abnormal on the payment method side.

Contact Antom Technical Support to know the specific reasons.  

UNKNOWN_EXCEPTIONUThe API call has failed, which is caused by unknown reasons.

Call the interface again to resolve the issue. If the problem persists, contact Antom Technical Support.