merchantAccept

Overview

POST /v1/payments/merchantAccept is used in escrow payment scenarios. After the mini-app merchant reviews the customer's order and verifies that the items are in stock and everything is fine (conditions are satisfied, etc.), the merchant may call this OpenAPI to accept the order.

All monetary amounts in requests and responses must be expressed in the smallest currency unit (IQD fils). For example, 100 IQD equals 100000.

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

Endpoint

API Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see: OpenAPIs Overview.

Request

Sample Request

{
  "paymentId": "2024071911121280010016601720002644"
}

Response

Sample Response

{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success."
  }
}

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.

Related Links

• pay (Use product code 51051000101000100008 for escrow)
• confirm
• cancel
• void