Verify Refund Order

Introduction

  • It is recommended that merchants verify if an order is eligible for a refund before processing it, to avoid duplicate refunds or order in non-refundable statuses (e.g., in payment processing).
  • If the status does not support a refund, an error code will be returned. See Return Code List for details.

Refund order supported all token and network for payment.

API Description

Request Method: POST

Request URL: open/api/payment/checkRefund

Body Parameters:

ParameterSignature RequiredRequiredTypeLengthDescription
appIdYesYesstring64appID
merchantOrderNoYesYesstring64Merchant order number
refundTokenYesYesstring32Refund token
refundNetworkYesYesstring32Refund network
refundAmountNoNostring32Refund amount
signNoYesstring128Signature

Example

Response Parameters:

ParameterTypeLengthDescription
orderNumstring32ach order number
paymentStatusstring32Payment status
refundOrderAmountstring32Refund order amount
orderCurrencystring32Order currency
withdrawLimitstring32Maximum and minimum refund limit

Response Example:

{
    "code": "0",
    "msg": "success",
    "model": {
        "orderNum": "300217186928983690133",
        "paymentStatus": "COMPLETED",
        "refundOrderAmount": 0.003833,
        "orderCurrency": "ETH",
        "withdrawLimit": "0.001149ETH~3833180.006133ETH"
    },
    "traceId": "670f7752c765235990e9accc36c44fa8",
    "success": true,
    "error": false
}