POST /v1/payments/capture

The capture 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 capture can only be initiated once, whether it is partial or full amount.

Depending on different scenarios, the capture API can be divided into the following two types:

• Full Capture

Capture the full amount of an authorized payment once. Full Capture is helpful for merchants who have a delayed order fulfillment process.

• Partial Captures

Capture the patial amount of an authorized payment once.

Note: All monetary values in the fields of request and response in their smallest currency units, and for IQD, the smallest unit is fils. Thus, if a transaction amount is 150 IQD, the value will be gaven as 150000.

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 wallet user authorizes a 1000 IQD to make a hotel reservation, and when the user leaves the hotel,  merchant/partner will call this capture API to the wallet to capture user‘s auth amount.

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 Mini Program creates an order with customerId.
9. The merchant backend calls the payment API to initialte payment flow, including customerId as referenceBuyerId, paymentNotifyUrl(optional), etc.
10. The E-Wallet backend returns payment detail information the merchant backend, such as redirectionUrl.
11. The merchant backend passes the payment detail information to the Mini Program.
12. The Mini Program calls the my.tradePay JSAPI with redirectionUrl to conduct the payment.
13. The E-Wallet App Service displays the cashier page with order information, such as amount, order details, etc.
14. The user confirms the payment in the cashier page.
15. The E-Wallet App Service calls payment service and execute the payment process.
16. When the payment reaches the final status, the E-wallet backend returns the payment result to the Mini Program (Step 18).
17. Also the E-wallet backend notifies the merchant backend of the payment result with paymentNotifyUrl provided in Step 10(Step 19).
18. Finally, E-wallet backend notifies the user of the payment result via SMS/Email/Inbox message (Step 20).
19. After the service or goods has been delivered, the user could confirm capture in the Mini Program or the merchant cashier (Step 21).
20. The Mini Program sends the capture request to merchant backend, and the merchant backend calls the capture API to capture the money(Step 23).
21. The E-Wallet backend returns the capture result to the merchant backend.
22. And the Mini Program displays the capture result to the user(Step 26).
23. When the E-Wallet backend returns the resultCode as CAPTURE_IN_PROCESS, the merchant can call inquiryPayment API to query capture result (Step 27).

Request

{
 "captureRequestId":"20231127190741010007013213156",
 "paymentId":"2023120611121280010016600090000xxxx",
 "captureAmount": {
    "value":"1000",
    "currency":"IQD"
 }
}

• captureRequestId is the unique ID of this capture request, generated by merchant/partner, merchant/partner should make sure it is unique, because wallet will use captureRequestId to do idempotent process.
• paymentId is the unique Id of a payment generated by Wallet, which is the unique payment identifier associated with this capture.

Response

{
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"Success."
 },
 "captureRequestId":"20231127190741010007013213156",
 "captureId":"2023120611121280010016600090000xxxx",
 "captureTime":"2021-06-08T12:12:12+08:00"
}

• result.resultStatus==S shows that the Wallet capture is successful.
• captureId is generated by Wallet, uniquely identifies the capture.
• captureTime describes the success date time of this capture.