POST /v1/payments/refund

The refund API is used to initiate a refund of a successful payment, refund a transaction and return money to the payer. The transaction can be refunded partially or fully. This API returns SUCCESS when deducting money from the merchant is successful.

Note:

1) The merchant/partner submits a refund request to wallets directly

2) Wallets determines whether the refund is successful based on its own payment status and respond to merchants/partners.

3) Multiple refund requests are supported for one successful payment, but the total refund amount can not be greater than the payment amount.

4) This API returns SUCCESS only means deducting money from the merchant is successful. The merchant can use the inquiryRefund API to determine the refund to payer status in the asynchronous refund processing scenario.

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

For example, a wallet user applies for refund of 100 IQD of a successful payment at the merchant/partner. So the merchant/partner will call this refund API to the wallet to refund money to users.

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

Request

{
  "refundRequestId": "2023112719074101000700000088881xxxx",
  "paymentId": "2023120611121280010016600090000xxxx",
  "refundAmount": {
    "currency": "IQD",
    "value": "10000"
  }
}

• refundRequestId is the unique ID of this refund request, generated by merchant/partner, merchant/partner should make sure it is unique, because wallet will use refundRequestId to do idempotent process.
• paymentId is the payment ID generated by Wallet, which is the unique payment identifier associated with this refund.
• refundAmount describes 100 IQD should refund to user, refund amount should less than origin payment amount. The amount to pay out for this refund.refundAmount.currency and paymentAmount.currency in payment request are the same. And if there are multiple refunds for a particular payment, the total successful refunded amount cannot exceed the payment amount in the payment transaction.

Note:

• paymentId and paymentRequestId and captureId can not both empty, wallet has to find out the origin payment order based on paymentId or paymentRequestId or captureId.

Response

{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success."
  },
  "refundId": "2023120611121280130016600090000xxxx",
  "refundTime": "2023-11-27T12:01:01+08:30"
}

• result.resultStatus==S shows that the Wallet refund is successful.
• refundId is generated by Wallet, uniquely identifies the refund.
• refundTime describes the success date time of this refund.