Query Refund Status
Request Method and Request Path
POST /payment/payin/v1/getRefundStatus
Request Header
| Field | Data Type | Mandatory | Description |
|---|---|---|---|
| content-type | string | Yes | Hard code with application/json |
| x-api-key | string | Yes | Provided by Paydify, equals to appId |
| x-api-timestamp | string | Yes | Current timestamp with millisecond |
| x-api-signature | string | Yes | See Signature Mechanism |
Request Body
| Field | Data Type | Mandatory | Description |
|---|---|---|---|
| appId | string | Yes | Merchant app ID, provided by Paydify |
| mchTxnId | string | No | Merchant refund order ID, one of mchTxnId, refundTxnId, or paymentTxnId must be provided |
| refundTxnId | string | No | Paydify refund order ID, one of mchTxnId, refundTxnId, or paymentTxnId must be provided |
| paymentTxnId | string | No | Paydify payment order ID, one of mchTxnId, refundTxnId, or paymentTxnId must be provided |
Response Header
| Field | Data Type | Mandatory | Description |
|---|---|---|---|
| x-api-key | string | Yes | Provided by Paydify, equals to appId |
| x-api-timestamp | string | Yes | Current timestamp with millisecond |
| x-api-signature | string | Yes | See Signature Mechanism |
Response Body
| Field | Data Type | Description |
|---|---|---|
| status | int | Error status, 0 indicates success, non-0 indicates failure, see Error Status |
| msg | string | Error description |
| data[i].refundTxnId | string | Refund unique order ID generated by Paydify |
| data[i].mchTxnId | string | Merchant order ID |
| data[i].paymentTxnId | string | Related payment order ID |
| data[i].txnHash | string | Transaction hash on-chain |
| data[i].txnAmount | string | Refund order amount, e.g. 1.23 |
| data[i].currency | string | Refund currency |
| data[i].payMethod2 | string | Network code, see Supported Network and Currency |
| data[i].appId | string | Provided by Paydify |
| data[i].state | string | Refund status, see Refund Status |
| data[i].mchExtInfo | string | Additional extended information, a JSON string |
| data[i].errorMsg | string | Reason of failure |
| data[i].envType | string | live or test |
| data[i].refundedTime | int | Default value is 0, a millisecond value is present only when the refund is validated |
| data[i].createdTime | int | Refund order created Time in millisecond |
| data[i].updatedTime | int | Latest modified Time in millisecond |
Examples
shell
# CURL
# Response Example of Success
{
"status": 0,
"msg": "success",
"data": [{
"refundTxnId": "2209141130105863014",
"mchTxnId":"xxkkkk",
"txnHash":"xxx",
"paymentTxnId": "220914xxx",
"txnAmount": "1.00",
"currency": "USDC",
"payMethod2": "bnb",
"appId": "A1111",
"state": "pending",
"mchExtInfo": "{JSON}",
"errorMsg": "失败原因",
"envType": "live",
"refundedTime": 2222222,
"createdTime": 2222222,
"updatedTime": 2222222,
}]
}
# Response Example of Failure
{
"status": 9999,
"msg": "system error",
"data": null
}# CURL
# Response Example of Success
{
"status": 0,
"msg": "success",
"data": [{
"refundTxnId": "2209141130105863014",
"mchTxnId":"xxkkkk",
"txnHash":"xxx",
"paymentTxnId": "220914xxx",
"txnAmount": "1.00",
"currency": "USDC",
"payMethod2": "bnb",
"appId": "A1111",
"state": "pending",
"mchExtInfo": "{JSON}",
"errorMsg": "失败原因",
"envType": "live",
"refundedTime": 2222222,
"createdTime": 2222222,
"updatedTime": 2222222,
}]
}
# Response Example of Failure
{
"status": 9999,
"msg": "system error",
"data": null
}