Documentation/API Reference

API REFERENCE

Order Query

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Order Query

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters1

Required fields first

Order Query

trade_idRequiredstringdata.trade_idYabandPay order number

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

ParameterTypeDescriptionRequired
userStringUID of the cashier or super administrator accountRequired
signStringSignatureRequired
methodStringv3.QueryOrderRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
trade_idStringYabandPay order numberRequired

Signature example:

Sorted parameters concatenated into a URL-style query string

"method=v3.QueryOrder&time=1728566835&trade_id=2eb629a8-96ad-d495-38f2-41f5bebf31cd&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.QueryOrder",
    "time": 1728566835,
    "data": {
        "trade_id": "2eb629a8-96ad-d495-38f2-41f5bebf31cd"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "transaction_info": {
            "trade_id": "2eb629a8-96ad-d495-38f2-41f5bebf31cd",
            "merchant_name": "Yaband Telecom B.V",
            "store_name": "YabandPay",
            "cashier_name": "YabandPay Test",
            "pay_method": "online",
            "sub_pay_method": "WeChat Pay",
            "order_id": "YOUR_ORDER_ID",
            "amount": "0.01",
            "tip_amount": "0.01",
            "currency": "EUR",
            "settlement_amount": "0.01",
            "settlement_currency": "EUR",
            "exchange_rate": "1",
            "description": "YabandPay Test",
            "redirect_url": "https://yabandpay.com/",
            "notify_url": "https://ordergoapi.yabandpay.com/api/Test/notify",
            "state": "paid",
            "time_out": "1440",
            "amount_cny": "0.07",
            "merchant_cost": "0.10",
            "transaction_id": "4200002425202409032894611438",
            "paid_at": "1725349108",
            "yb_transaction_id": "b228f7d3-b56b-5210-d270-5e5f23690db0",
            "icon_url": "https://partner.yabandpay.com/Public/Admin/image/wechat3x.png?v=202310201461",
            "payer_profile": {
                "payer_name": "UNKNOWN",
                "payer_ip": "208.87.243.129",
                "payer_bank_account": "451761***1527",
                "issuer_name": "",
                "expiry_month": "",
                "expiry_year": "",
                "par": "XXXXXXXXXXXXXXXXXXX"
            },
            "refund_info": [
                {
                    "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"
                }
            ],
            "createDate": "1725349082",
            "user": "YOUR_CASHIER_UID"
        }
    },
    "message": ""
}

Additional information:

Funds status codes and descriptions:
fund_flow_statusfund_flow_description
0uncleared
1cleared
2settled
Parameter descriptions:

For response parameter descriptions, see Asynchronous Notifications.