POST /v1/payments/void

The void API is used to void a paid order before the payment is captured or the order confirmed by a merchant or payer, and then return money to the payer. There are the following two types of voiding a paid order:

• Partially void: To partially void a paid order will return a part of the payment amount to the payer. It will not change the order status. There is a timeout setting for the remaining payment amount. Once the time is out of the setting, the remaining payment amount will be voided or confirmed automatically.
• Fully void: To fully void an order will close the order automatically.

The timeout setting is available when the remaining payment amount is voided or confirmed automatically if the session timeout is set.

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. The following table describes each result status:

Error code

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, there are still scheduled days left, merchant/partner will call this void API to the wallet to return money to the payer.

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 void in the Mini Program or the merchant cashier (Step 21).
20. The Mini Program sends the void request to merchant backend, and the merchant backend calls the void API to refund the money(Step 23).
21. The E-Wallet backend returns the void result to the merchant backend.
22. And the Mini Program displays the void result to the user(Step 26).
23. When the E-Wallet backend returns the resultCode as VOID_IN_PROCESS, the merchant can call inquiryPayment API to query void result (Step 27).
    

Request

{
 "voidAmount": {
    "value":"1000",
    "currency":"IQD"
 },
 "paymentId":"2023120611121280170016600090000xxxx",
 "voidRequestId":"202331231313123124"
}

• voidRequestId is the unique ID of this capture request, generated by merchant/partner, merchant/partner should make sure it is unique, because wallet will use voidRequestId 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."
 },
 "voidId":"2023120611121280170016600090000xxxx",
 "voidRequestId":"202331231313123124"
}

• result.resultStatus==S shows that the Wallet void is successful.
• voidId is generated by Wallet, uniquely identifies the void.