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

Request Parameters

Body Parameters:

ParameterSignature RequiredRequiredTypeLengthDescription
appIdYesYesstring64appID
merchantOrderNoYesYesstring64Merchant order number
signNoYesstring64Signature

Response Parameters

ParameterSignature RequiredTypeLengthDescription
refundTypeYesstring64Refund type
merchantOrderNoYesstring64Merchant order number
paymentOrderNoYesstring64ACH payment order number
orderStatusYesstring16Refund order status: INIT,PENDING,SUCCESS,FAILED
tokenAmountYesstring16Token amount
faitAmountYesstring16Fiat amount
fiatCurrencyYesstring16Fiat currency
refundNetworkYesstring32Refund network (e.g., TRX)
refundTokenYesstring32Refund token (e.g., USDT)
hxAddressYesstring256Hash address of the refund order
refundOrderNoYesstring64ACH refund order number

Refund Type Parameters

Refund TypeValueDescription
USER_WITHDRAW"USER_WITHDRAW"User-initiated withdrawal
MERCHANT_APPROVE_REFUND"MERCHANT_APPROVE_REFUND"Merchant-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
}