Reports
This API is used to query YabandPay's clearing reports.
[!TIP|style:flat]
YabandPay performs clearing program for all transactions of the previous day at 4 AM daily (Netherlands time) and generates reports. It is recommended to query after 7 AM Netherlands time.
Clearing reports will be generated daily for each store and each payment method. For example, if a store has two payment methods, two reports will be generated daily.
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 | getTradebill | Required |
| bill_date | String | date format dd-MM-yyyy, only the latest three months are accepted. | Required |
| nonce_string | String | random string, no longer than 32 characters | Required |
Signature:
Lexicographical sequence and URL key-value format new string
"bill_date=2024-02-19&command=getTradebill&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Use stringA and secret_key to get stringSign
Get Signature：
"9abdb20d59573ded6b415adf871aeddcb7896ad954e7828b39d9f14b65a3464a"
Example Request:
{
"user": "040268",
"sign": "d9dc3b2900c618368b8fd337b1d050c282621543a5db37f588d7f99836b19fab",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebill",
"bill_date": "19-02-2024",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Example Response:
{
"status": true,
"code": 200,
"message": "",
"data": {
"tradebill": [
{
"time_zone": "GMT+1",
"MID": 102300,
"merchant_name": "Yaband Telecom B.V.",
"store_name": "YabandPay",
"sub_pay_method": "WeChat Pay",
"settlement_currency": "EUR",
"number_of_payment": 8,
"amount_of_payment": "53.25",
"number_of_refund": 0,
"amount_of_refund": "0.00",
"fee": "0.9",
"net_value": "52.35",
"vat": "0.19",
"state": "settled",
"transaction_date": "2024-02-19",
"due_date": "2024-02-21",
"settlement_date": "2024-02-21",
"clearing_id": "M20240220001503109569"
},
{
"time_zone": "GMT+1",
"MID": 102300,
"merchant_name": "Yaband Telecom B.V.",
"store_name": "YabandPay",
"sub_pay_method": "Alipay",
"settlement_currency": "EUR",
"number_of_payment": 9,
"amount_of_payment": "67.85",
"number_of_refund": 0,
"amount_of_refund": "0.00",
"fee": "1.23",
"net_value": "66.62",
"vat": "0.20",
"state": "settled",
"transaction_date": "2024-02-19",
"due_date": "2024-02-21",
"settlement_date": "2024-02-21",
"clearing_id": "M20240220001503109614"
}
],
"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 |
| MID | String | the UID of super admin account |
| merchant_name | String | Merchant name |
| store_name | String | Store name |
| sub_pay_method | String | Payment method |
| settlement_currency | String | Settlement currency, ISO 4217 |
| number_of_payment | String | Number of payment |
| amount_of_payment | String | Total amount of payment transactions |
| number_of_refund | String | Number of refund transactions |
| amount_of_refund | String | Total amount of refund |
| fee | String | Transaction fee |
| net_value | String | Net transaction value, excluding VAT |
| vat | String | The VAT of transaction fee |
| state | String | Settlement status: processing or settled |
| transaction_date | String | Transaction date |
| due_date | String | Expected settlement date |
| settlement_date | String | Actual settlement date |
| clearing_id | String | Clearing ID |
| count | String | Number of returned data items |