Transactions

This API is used to query the transactions of clearing reports or to query the transactions by date period.

[!TIP|style:flat]

Transactions only include transactions involving fund settlement, such as payments or refunds, and do not include transactions such as cancellations or authorizations.

If you query by date period, the period cannot exceed one year.

Transactions older than 7 years are not supported for query.

This API can only be called by the merchant super admin account; the operator or cashier accounts do not have permission to call this API.

API URL：https://mapi.yabandpay.com/Payments

Method：POST

POST data type：Json

Parameter	Type	Description	Required
user	String	the UID of super admin account	Required
sign	String	signature	Required
method	String	v3.CreatePayments	Required
time	Long	timestamp	Required

Parameter

Parameter	Type	Description	Required
command	String	getTradebillinfo	Required
clearing_id	String	the ID of clearing report	Optional
start_time	String	start time	Optional
end_time	String	end time	Optional
nonce_string	String	random string, no longer than 32 characters	Required

Signature:

Lexicographical sequence and URL key-value format new string

"clearing_id=M20240302001503350733&command=getTradebillinfo&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"

Use stringA and secret_key to get stringSign

Get Signature：

"9abdb20d59573ded6b415adf871aeddcb7896ad954e7828b39d9f14b65a3464a"

Example Request - Clearing report:

{
    "user": "036870",
    "sign": "9abdb20d59573ded6b415adf871aeddcb7896ad954e7828b39d9f14b65a3464a",
    "method": "v3.GetTradebill",
    "time": 1708422208,
    "data": {
        "command": "getTradebillInfo",
        "clearing_id": "M20240220001503109569",
        "nonce_string": "tw5be5b7sry5prm96s"

    }
}

Example Request - Date period:

{
    "user": "036870",
    "sign": "a731d19eda0526653483f9d9384a068f19f29c2e291b23231678dfe0ef008432",
    "method": "v3.GetTradebill",
    "time": 1708422208,
    "data": {
        "command": "getTradebillInfo",
        "start_time": "1716393600",
        "end_time" : "1716566340",
        "nonce_string": "g46a5g156rt4784ghb1b"

    }
}

Example Response:

{
    "status": true,
    "code": 200,
    "message": "",
    "data": {
        "tradebill": [
            {
                "time_zone": "GMT+1",
                "store_name": "Test Store",
                "date": "21-02-2024 19:03:21",
                "settlement_currency": "EUR",
                "amount": "2.00",
                "fee": "0.02",
                "net_value": "1.98",
                "vat": "0.01",
                "type": "payment",
                "sub_pay_method": "WeChat Pay",
                "order_id": "2024022165484654893",
                "trade_id": "ed71a5db-8e1c-a883-d062-ccbb4005b914",
                "description": "test order",
                "demo": "",
                "state": "paid",
                "fund_flow_status": "2",
                "fund_flow_description": "settled",
            },
            {
                "time_zone": "GMT+1",
                "store_name": "Test Store"
                "date": "21-02-2024 20:25:43",
                "settlement_currency": "EUR",
                "amount": "2.00",
                "fee": "0.02",
                "net_value": "1.98",
                "vat": "0.01",
                "type": "Payment",
                "sub_pay_method": "WeChat Pay",
                "order_id": "2024022165484654893",
                "trade_id": "ed71a5db-8e1c-a883-d062-ccbb4005b914",
                "description": "test order",
                "demo": "",
                "state": "paid",
                "fund_flow_status": "2",
                "fund_flow_description": "settled",
            }
        ],
        "count": 2
    }
}

More Information：

The response parameters are described as follows:

Parameter	Type	Description
time_zone	String	Clearing time zone, usually the time zone of the merchant's registered country
store_name	String	Store name
date	String	Date of transaction completion
settlement_currency	String	Settlement currency, ISO 4217
amount	String	Settlement amount
fee	String	Transaction fee
net_value	String	Net value, excluding VAT
vat	String	The VAT of transaction fee
type	String	Transaction type, `Payment` or `Refund`
sub_pay_method	String	Payment method
order_id	String	Merchant torder ID
trade_id	String	Yabandpay trade ID
description	String	Transaction description
demo	String	Merchant's custom field
state	String	Transaction status, either `Paid` or `Refunded`
fund_flow_status	String	Fund flow status code
fund_flow_description	String	Fund flow status description
count	String	Number of returned data items

Funding Status Codes and Descriptions:

fund_flow_status	fund_flow_description
0	uncleared
1	cleared
2	settled

Transacionts