Refund Order Query API

Introduction

After processing a refund, merchants can use this API to check the refund status of an order.

API Description

Request Method: POST

Request URL: open/api/payment/refundQuery

Body Parameters

ParameterSignature RequiredRequiredTypeLengthDescription
appIdYesYesstring64Application ID
merchantOrderNoYesYesstring64Merchant order number
signNoYesstring64Signature
Check on the sign

Response Parameters

ParameterTypeLengthDescription
refundTypestring64Refund type (see Refund Type Parameters below)
merchantOrderNostring64Merchant order number
paymentOrderNostring64ACH payment order number
orderStatusstring16Refund order status: INIT, PENDING, SUCCESS, FAILED
tokenAmountstring16Token amount
faitAmountstring16Fiat amount
fiatCurrencystring16Fiat currency
refundNetworkstring32Refund network (e.g., TRX)
refundTokenstring32Refund token (e.g., USDT)
hxAddressstring256Hash address of the refund order
refundOrderNostring64ACH refund order number

Refund Type Parameters

ValueRefund TypeDescription
USER_WITHDRAWUSER_WITHDRAWUser-initiated withdrawal
MERCHANT_APPROVE_REFUNDMERCHANT_APPROVE_REFUNDMerchant-initiated refund

Response Example

{
    "code": "0",
    "msg": "success",
    "model": [
        {
            "refundType": "MERCHANT_APPROVE_REFUND",
            "merchantOrderNo": "17192822400000test",
            "refundOrderNo": "131313131",
            "paymentOrderNo": null,
            "orderStatus": "INIT",
            "refundCurrency": null,
            "refundNetwork": null,
            "refundAmount": "6.00",
            "hxAddress": null
        }
    ],
    "traceId": "66d98888e6d82738ab3841e8906fb7a6",
    "success": true,
    "error": false
}

Did this page help you?