POST /v1/payments/pay

The pay API is used to initiate a payment request to wallets.

Note: A payment which takes place at wallets.

1）The merchant/partner initiates a payment request to wallet through this interface.

2）The wallet will handle different payment scenarios based on the parameters in the request.

Currently, this API support following scenarios:

• Cashier payment：Usually used in the online payment scenario. In this scenario, the merchant/partner will call this API to create an order, and the wallet will return the cashier page URL to the merchant/partner, and then redirect to this cashier page. So user can finish the payment in the cashier page.

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 are focused 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 as follows.

Error codes

Error codes are usually classified into the following categories:

• Common error codes: are common for all Mini Program OpenAPIs.  
• API-specific error codes: are listed in the following table.

Sample

Cashier Payment

For example, a user purchases a 100 IQD good at the merchant/partner(online merchant usually) , the merchant/partner calls this API to create the payment order first, the wallet will return the payment order ID and wallet cashier page URL to the merchant/partner, then merchant/partner can redirect user to wallet cashier page with the my.tradePay  API.

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

Request

{
    "productCode": "51051000101000000011",
    "paymentRequestId": "UDQzzvxwyvrUDxGqhMlHUIBpGkydOQC6",
    "paymentAmount": {
        "currency": "IQD",
        "value": "116000"
    },
    "order": {
        "orderDescription": "order description",
        "buyer": {
            "referenceBuyerId": "21661000000003660xxxx" 
        }
    },
    "paymentExpiryTime": "2024-01-18T16:10:36+03:00",
    "paymentNotifyUrl":"https://www.merchant.com/paymentNotifyxxx"  
}

• paymentRequestId is generated by the merchant/partner, which uniquely identifies the payment. Wallet must make use of paymentRequestId for idempotent control. For example, if a payment with paymentRequestId== 2023112719074101000700000077771 has been processed successfully by Wallet, when the merchant/partner uses the same paymentRequestId for payment, Wallet will respond with sucessful payment.
• productCode is the product code, The wallet uses the productCode to get the contract configuration which includes fee, limitation information, and so on.

• Online Purchase: "51051000101000000011"
• Online Purchase(Auth Capture): "51051000101000000012"
• Agreement Payment: "51051000101000100031"

• paymentNotifyUrl is the URL defined by the merchant/partner.  In the cashier payment scenario, after the user finished payment in the wallet cashier page, the wallet will notify the merchant of the payment result based on this URL.
• paymentAmount describes the amount of 100 IQD to be collected by Wallet from user's account for this payment.
• order describes the order details of the purchase of the 100 IQD merchandise by the  user at the  merchant. Such as Merchant, Buyer, Goods, etc are included in order. The information in the Order is only used to  display user's payment result page and transactions history,  regulation reporting, etc.
• referenceBuyerId is the unique userID, which can be customerId obtained from accessToken information in applyToken API. It must not be default. Please make sure the buyer and the payer is the same person.
• paymentExpiryTime is the payment order close time defined by merchant, which means the payment order will be closed automatically after paymentExpiryTime. If empty, the expiryTime will be defined by E-wallet.

Response

{
 "result": {
    "resultCode":"ACCEPT",
    "resultStatus":"A",
    "resultMessage":"accept"
 },
 "paymentId": "2023120611121280010016600090000xxxx",
 "redirectActionForm":{
    "redirectionUrl":"https://www.wallet.com/cashier?orderId=xxxxxxx"
 }
}

• result.resultStatus ==A shows that the  payment is accept success. After user finish payment in cashier page, payment will change to success.
• paymentId is generated by Wallet, uniquely identifies the payment.
• redirectActionForm returns the cashier page URL to the merchant/partner. After the merchant/partner receives the accept result, which will be redirected to this URL.

Agreement Payment

For example, a user authorizes a AgreementPay contract at the merchant/partner(online merchant usually), such as monthly subscription, the merchant/partner can call this API to automatically deduct money from the user's wallet without user's operation.

1. The Mini Program calls merchant backend to prepare the contract.
2. The merchant backend calls this prepare API with contract information to prepare the contract.
3. The E-Wallet backend returns authorization information to the merchant backend, such as authorizationUrl.
4. The merchant backend passes the authorization information to the Mini Program.
5. The Mini Program calls the my.call("qicardSignContract") JSAPI with authorizationUrl to conduct the authorization.
6. The E-Wallet App Service displays the authorization page with contract information provided in Step 2.
7. The user confirms the authorization agreement pay in the authorization page.
8. The E-Wallet App Service calls authorization service and execute the authorization process.
9. When the authorization reaches the final status, the E-wallet backend returns the authCode to the Mini Program (Step 10).
10. The Mini Program sends the authCode merchant backend.
11. The merchant backend calls this applyToken API with authCode to apply the accessToken(Step 12).
12. The E-Wallet backend returns accessToken information to the merchant backend, such as accessToken, refreshToken, etc.
13. The merchant backend calls this payment API with accessToken to deduct money from user's balance silently without user operation(Step 14).
14. The E-wallet backend returns the payment result to the merchant backend instantly(Step 15).
15. Also the E-wallet backend notifies the merchant backend of the payment result with paymentNotifyUrl provided in Step 14(Step 16).
16. Finally, E-wallet backend notifies the user of the payment result via SMS/Email/Inbox message (Step 17).

Request

{
  "productCode": "51051000101000100031",
  "paymentRequestId": "UDQzzvxwyvrUDxGqhMlHUIBpGkydOQC6",
  "paymentAuthCode": "000000000220231001JfQ6vpiUNV79nT00006725",
  "paymentAmount": {
    "currency": "IQD",
    "value": "116000"
  },
  "order": {
    "orderDescription": "order description"
  },
  "paymentExpiryTime": "2024-01-18T16:10:36+03:00",
  "paymentNotifyUrl": "https://www.merchant.com/paymentNotifyxxx"
}

• paymentRequestId is generated by the merchant/partner, which uniquely identifies the payment. Wallet must make use of paymentRequestId for idempotent control. For example, if a payment with paymentRequestId== 2023112719074101000700000077771 has been processed successfully by Wallet, when the merchant/partner uses the same paymentRequestId for payment, Wallet will respond with sucessful payment.
• productCode is the product code, The wallet uses the productCode to get the contract configuration which includes fee, limitation information, and so on.
• paymentNotifyUrl is the URL defined by the merchant/partner.  In the cashier payment scenario, after the user finished payment in the wallet cashier page, the wallet will notify the merchant of the payment result based on this URL.
• paymentAmount describes the amount of 100 IQD to be collected by Wallet from user's account for this payment.
• order describes the order details of the purchase of the 100 IQD merchandise by the  user at the  merchant. Such as Merchant, Buyer, Goods, etc are included in order . The information in the Order is only used to  display user's payment result page and transactions history,  regulation reporting, etc.
• paymentAuthCode was generated by the wallet is the accessToken in the agreement pay scenario.
• paymentExpiryTime is the payment order close time defined by merchant, which means the payment order will expire automatically after paymentExpiryTime. If empty, the expiryTime will be defined by E-wallet.

Response

{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "Success."
  },
  "paymentId": "20231030111212800100166794100052745",
  "paymentTime": "2023-10-30T09:17:13+03:00"
}

• result.resultStatus ==S shows that the  payment is success.
• paymentId is generated by Wallet, uniquely identifies the payment.
• paymentTime is generated by Wallet, it shows the payment finish time.