Antom, leading provider of tailored payment solutionsAntom, leading provider of tailored payment solutions

notifyPayment

Alipay uses the notifyPayment API to send the payment result to the merchant when the payment processing reaches a final state of success or failure. Merchants promote merchant-side transactions based on the payment result.  

Request parameters

notifyType String  REQUIRED

Payment status notification type. Valid values are:  

  • PAYMENT_RESULT: Indicates that the notification is a payment result.
  • OFFLINE_PAYMENT_CODE: Indicates that the notification is an offline payment code.

result Result  REQUIRED

The payment result

Show child parameters

paymentRequestId String  REQUIRED

The unique ID that is assigned by a merchant to identify a payment request. Special characters are not supported.

More information:

  • Maximum length: 64 characters

paymentId String  

The unique ID that is assigned by Alipay to identify a payment. A one-to-one correspondence between paymentId and paymentRequestId exists.

More information:

  • Maximum length: 64 characters

paymentAmount Amount  REQUIRED

The payment amount that the merchant requests to receive in the order currency.

Show child parameters

paymentCreateTime Datetime  

The date and time when the payment is created, which follows the ISO 8601 standard.

paymentTime Datetime  

The date and time when the payment reaches a final state of success or failure, which follows the ISO 8601 standard.

pspCustomerInfo PspCustomerInfo  

Information about the customer of payment method provider (PMP).

Note: PMP, payment method provider, is an organization that processes payment services and other value-added services on behalf of the payer.

Show child parameters

Response parameters

result Result  REQUIRED

The request result, which contains information related to the request result, such as status and error codes.

Show child parameters

customsDeclarationAmount Amount  

The total amount for customs declaration. This field is returned only when the wallet is Alipay CN.

Show child parameters
API Explorer

Request

Case
A successful payment result
Request Body

Response

Response Body

More information 

This section provides additional information about certain parameters. See the following parameters for details:

  • result (in the notification request sent by Alipay): 
    Payment result. If the value of result.resultStatus is S, then the payment succeeds. If the value is F, the payment fails. The value of result.resultStatus will not be U for the payment result notification.
  • paymentTime: 
    This field is returned only when the value of result.resultStatus is S.
  • paymentActionForm: 
    In the in-store payment scenario, paymentCode is passed in through this field, and merchants can display the code to the customer. 

Result process logic

The merchant needs to send SUCCESS to Alipay after receiving the notification. If no asynchronous notification is returned to Alipay as required or due to network issues, Alipay will retry the notification request within 24 hours until SUCCESS is returned by the merchant. The notification request is called up to eight times, with an interval of 0s, 2m, 10m, 10m, 1h, 2h, 6h, 15h.

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
USER_KYC_NOT_QUALIFIEDFPayment failed because of the user's KYC status. The user is either not KYC compliant, or the KYC status is not qualified for this transaction (for example, limitations on the payment amount or product information).