inquireRefund
POST: /amsin/api/v1/business/inquireRefund
After the refund is completed, the Partner can use this API to query the refund results.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
Field | Data type | Required | Description |
refundRequestIds | Array<String> | Yes (Conditional) | The unique id assigned by the Partner to identify a refund order. |
refundIds | Array<String> | Yes (Conditional) | The unique id assigned by the WorldFirst to identify a refund order. |
Response parameters
Field | Data type | Required | Description |
result | Result object | Yes | Indicates the result of the API call. |
refundInformation | Array<RefundInfo> object | Yes | Indicates the information of the refund order, such its currency, status, id and etc. |
Result codes
resultCode | resultStatus | resultMessage | Further action |
SUCCESS | S | Success | |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section. |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support. |
REFUND_ORDER_NOT_EXIST | F | The refund order does not exist. | The refund order is invalid. |
Samples
Request
{
"refundIds":["202311271540108013001888202057*****"]
}or
{
"refundRequestIds":["yidong_refund_requestId_17010*****"]
}Response
{
"refundInformation": [
{
"payToId": "202311271540108001001888202063*****",
"refundAmount": {
"currency": "USD",
"value": "400"
},
"refundId": "202311271540108013001888202057*****",
"refundOrderDetails": [
{
"paymentMethodType": "WALLET_WF",
"refundActualAmount": {
"currency": "USD",
"value": "400"
}
},
{
"fundType": "FEE",
"paymentMethodType": "WALLET_WF",
"refundActualAmount": {
"currency": "USD",
"value": "1"
}
}
],
"refundRequestId": "yidong_refund_requestId_17010*****",
"refundStatus": "SUCCESS",
"refundTime": "2023-11-27T05:59:36-08:00"
}
],
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
}
}