POST /v1/payments/confirm

The confrim API is used to capture the total authorized payment amount from a user's account, and then transfer the total amount of the payment to a merchant's account after the user confirms receipt. The confrim can only be initiated once and in full.

Note: The merchant may call the confirm API to notify A+ that the order has been confirmed only after the customer has actually completed the order confirmation.

Message structure

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

• Request header
• Response header

Request

Response

Result process logic

In the response, the result.resultStatus field indicates the result of processing a request. The following table describes each result status:

Error codes

Error codes are usually classified into the following categories:

• Common error codes are common across all mini program's APIs.  
• API-specific error codes: are listed in the following table.

Samples

For example, a customer pays 1,000 IQD for a meal on a food delivery platform. After the order is delivered and the customer verifies that the items are correct and in good condition (e.g., correct quantity, acceptable quality, no spillage), the customer may then confirm the order.

1. The Mini Program calls this my.getAuthCode JSAPI with specific scopes(USER_ID) to request an authorization code.
2. The E-wallet App service calls authorization service to processes the authorization information.
3. The E-wallet backend verifies the authorization information, generates the authCode and returns.
4. The E-wallet App service returns the authCode to the Mini Program.
5. The Mini Program sends the authCode to the merchant backend.
6. The merchant backend calls the applyToken API with authCode to apply the accessToken.
7. The E-Wallet backend returns accessToken information to the merchant backend, such as customerId, accessToken, refreshToken, etc.
8. The merchant backend returns customerId to mini program.
9. The Mini Program creates an order with customerId.
10. The merchant backend calls the payment API to initialte payment flow, including customerId as referenceBuyerId, paymentNotifyUrl(optional), etc.
11. The E-Wallet backend returns payment detail information the merchant backend, such as redirectionUrl.
12. The merchant backend passes the payment detail information to the Mini Program.
13. The Mini Program calls the my.tradePay JSAPI with redirectionUrl to conduct the payment.
14. The E-Wallet App Service displays the cashier page with order information, such as amount, order details, etc.
15. The user confirms the payment in the cashier page.
16. The E-Wallet App Service calls payment service and execute the payment process.
17. When the payment reaches the final status, the E-wallet backend returns the payment result to the Mini Program (Step 19).
18. The E-Wallet App Service returns the payment result to mini program.
19. Also the E-wallet backend notifies the merchant backend of the payment result with paymentNotifyUrl provided in Step 10.
20. Finally, E-wallet backend notifies the user of the payment result via SMS/Email/Inbox message .
21. Merchant backend calls the merchantAccept API to accept this order.
22. The E-Wallet backend returns the merchantAccept result to the merchant backend.
23. The Mini Program sends the confirm request to merchant backend, and the merchant backend calls the confrim API to capture the money(Step 25).
24. The E-Wallet backend returns the confirm result to the merchant backend.
25. And the Mini Program displays the confirm result to the user(Step 28).
26. When the E-Wallet backend returns the resultCode as CONFIRM_IN_PROCESS, the merchant can call inquiryPayment API to query confirm result (Step 29).

Request

{
 "paymentId":"20240719111212800100166017200026447",
 "confrimRequestId":"202331231313123123"
}

• paymentId is the unique Id of a payment generated by Wallet, which is the unique payment identifier associated with this confirm.

Response

{
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"Success."
 },
 "confrimId":"20240719111212801800166013400002704",
 "confirmTime":"2024-07-19T12:12:12+08:00"
}

• result.resultStatus==S shows that the Wallet confirm is successful.