API REFERENCE

Refund Query

YabandPay documentation·Updated Oct 26, 2026

Parameter	Type	Description	Required
user	String	Cashier account UID	Required
sign	String	Signature	Required
method	String	v3.QueryRefundOrder	Required
time	Long	Timestamp	Required

Parameters

Parameter	Type	Description	Required
refund_id	String	YabandPay refund order number	Optional (one must be included)
m_refund_id	String	Merchant refund order number	Optional (one must be included)

Signature example:

Sorted parameters concatenated into a URL-style query string

"method=v3.QueryRefundOrder&time=1728566835&refund_id=3841510a-4d18-4a61-808d-431a45006de2&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.QueryRefundOrder",
    "time": 1728566835,
    "data": {
        "refund_id": "3841510a-4d18-4a61-808d-431a45006de2"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {

            "transaction_id": "20240903153820059756",
            "refund_id": "20240903154342497308",
            "m_refund_id": null,
            "refund_time": "1725349422",
            "state": "refunded",
            "refund_amount": "0.01",
            "refund_currency": "EUR",
            "refund_description": "gary",
            "notify_url": "null",
            "demo": "",
            "settlement_refund_amount": "0.01",
            "settlement_refund_currency": "EUR",
            "merchant_cost": "0.1",
            "yb_transaction_id": "c07859aa-3d12-69d4-ef2f-a9556d9c4d33"
        },
    "message": ""
}

Additional information:

Response result:

A successful request returns "status": true.
A failed request returns "status": false.

Refund status:

Code	State	Message
20	to-be-approval	Awaiting administrator approval.
21	refund pending	The current balance is insufficient. The refund is submitted automatically when sufficient funds are available.
22	refund processing	The refund request has been submitted and is being processed by the system.
23	refunded	The refund has completed successfully.
24	refund failed	The refund failed. Please try again.
25	refund error	The refund failed. Please contact our online customer support.
26	refund cancelled	The refund order has been cancelled.