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

Request Parameters

Body Parameters

ParameterSignature RequiredRequiredTypeLengthDescription
appIdYesYesstring64appID
merchantOrderNoYesYesstring64Merchant order number
refundTokenYesYesstring32Refund token
refundNetworkYesYesstring32Refund network
refundAmountNoNostring32Refund amount(in fiat same as order amount, EUR/USD)
signNoYesstring128Signature
Check on About the sign

Request Parameter Example

{
  "appId": "your_app_id_here_1234567890abcdef",
  "merchantOrderNo": "merchant_order_20250427_001",
  "refundToken": "refund_token_abcdef123456",
  "refundNetwork": "VISA",
  "sign": "your_signature_value_abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef12345678"
}

Response Parameters

Body Parameters

ParameterTypeLengthDescription
orderNumstring32ach order number
paymentStatusstring32Payment status
refundOrderAmountstring32Refund order amount
orderCurrencystring32Order currency
withdrawLimitstring32Maximum and minimum refund limit
Error withdraw limit:
front number:minimum amount of this refund token and network
second number:minimum amount of this order refund

Response Parameter 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
}