notifyPayment
Alipay uses the notifyPayment API to send the payment result to the merchant when the payment processing reaches a final state of success. Merchants promote merchant-side transactions based on the payment result.
Request parameters
Payment 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.
The payment result
Result status. Possible values are:
- S: Indicates that the result status is successful.
- F: Indicates that the result status is failed.
- U: Indicates that the result status is unknown.
The payment amount that the merchant requests to receive in the order currency.
The 3-letter currency code that follows the ISO 4217 standard.
The amount to charge as a positive integer in the smallest currency unit. (That is, 100 cents to charge $1.00, or 100 to charge JPY ¥100, a zero-decimal currency).
Notes: For more information about the smallest currency unit, see Currency codes for details.
The date and time when the payment is created, which follows the ISO 8601 standard.
The date and time when the payment reaches a final state of success or failure, which follows the ISO 8601 standard.
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.
The name of PSP.
Note: PMP, payment method provider, is an organization that processes payment services and other value-added services on behalf of the payer.
The customer ID of PMP.
Note: PMP, payment method provider, is an organization that processes payment services and other value-added services on behalf of the payer.
Total settlement amount, which equals to transaction amount multiplied by the value of settlementQuote.
Note:
This field is empty when the settlement currency is the same as the transaction currency.
The 3-letter currency code that follows the ISO 4217 standard.
The amount to charge as a positive integer in the smallest currency unit. (That is, 100 cents to charge $1.00, or 100 to charge JPY ¥100, a zero-decimal currency).
Notes: For more information about the smallest currency unit, see Currency codes for details.
The exchange rate between the settlement currency and transaction currency at the time of transaction, which is provided only in the locked-in rate case.
Note:
This field is empty when the settlement currency is the same as the transaction currency.
Effective time of the exchange rate, which follows the ISO 8601 standard
Expiration time of the exchange rate, which follows the ISO 8601 standard
Response parameters
The request result, which contains information related to the request result, such as status and error codes.
Result status. Possible values are:
- S: Indicates that the result status is successful.
- F: Indicates that the result status is failed.
- U: Indicates that the result status is unknown.
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 isS, then the payment succeeds. - paymentTime:
This field is returned only when the value of result.resultStatus isS. - 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
If the value of result.resultStatus is S, the payment result notification succeeds. Alipay doesn't take any further actions.
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| UNKNOWN_EXCEPTION | U | An API calling is failed, which is caused by unknown reasons. |