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:

Parameter	Signature Required	Required	Type	Length	Description
appId	Yes	Yes	string	64	appID
merchantOrderNo	Yes	Yes	string	64	Merchant order number
sign	No	Yes	string	64	Signature

Response Parameters

Parameter	Signature Required	Type	Length	Description
refundType	Yes	string	64	Refund type
merchantOrderNo	Yes	string	64	Merchant order number
paymentOrderNo	Yes	string	64	ACH payment order number
orderStatus	Yes	string	16	Refund order status: INIT,PENDING,SUCCESS,FAILED
tokenAmount	Yes	string	16	Token amount
fiatAmount	Yes	string	16	Fiat amount
fiatCurrency	Yes	string	16	Fiat currency
refundNetwork	Yes	string	32	Refund network (e.g., TRX)
refundToken	Yes	string	32	Refund token (e.g., USDT)
hxAddress	Yes	string	256	Hash address of the refund order
refundOrderNo	Yes	string	64	ACH refund order number

Refund Type Parameters

Refund Type	Value	Description
USER_WITHDRAW	"USER_WITHDRAW"	User-initiated withdrawal
MERCHANT_APPROVE_REFUND	"MERCHANT_APPROVE_REFUND"	Merchant-initiated refund

Response Example

JSON

{
    "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
}