API REFERENCE
Clearing reports
This API retrieves YabandPay clearing reports.
Tip
- YabandPay clears all transactions from the previous day at 4 a.m. daily (Netherlands time) and generates reports. We recommend querying after 7 a.m. Netherlands time.
- A clearing report is generated daily for each store and payment method. For example, a store with two payment methods receives 2 reports per day.
- Only merchant super administrator accounts can call this API. Operator and cashier accounts are not authorized to call it.
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | UID of the super administrator account | Required |
| sign | String | Signature | Required |
| method | String | v3.GetTradebill | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| command | String | getTradebill | Required |
| bill_date | String | Bill date in dd-MM-yyyy format. Download requests are supported only for bills from the past three months. | Required |
| nonce_string | String | Random string, no longer than 32 characters | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"bill_date=2024-02-19&command=getTradebill&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Sign stringA using secret_key
The resulting signature is:
"YOUR_SIGNATURE"
Request example:
{
"user": "040268",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebill",
"bill_date": "19-02-2024",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Response example:
{
"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
}
}
Additional information:
Response parameter descriptions:
| Parameter | Type | Description |
|---|---|---|
| time_zone | String | Clearing time zone, usually the time zone of the merchant's country of registration |
| MID | String | Merchant's MID |
| merchant_name | String | Merchant name |
| store_name | String | Merchant store name |
| sub_pay_method | String | Payment method |
| settlement_currency | String | Settlement currency, ISO 4217 |
| number_of_payment | String | Number of payment transactions |
| amount_of_payment | String | Total payment transaction amount |
| number_of_refund | String | Number of refund transactions |
| amount_of_refund | String | Total refund transaction amount |
| fee | String | Transaction fees |
| net_value | String | Net transaction value before VAT deduction |
| vat | String | VAT on all transaction fees |
| state | String | Settlement status: processing or settled |
| transaction_date | String | Date the transaction occurred |
| due_date | String | Expected settlement date |
| settlement_date | String | Actual settlement date |
| clearing_id | String | Clearing ID |
| count | String | Number of records returned |
