Documentation/API Reference

API REFERENCE

Clearing reports

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

Clearing reports

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

Request parameters3

Required fields first

Clearing reports

commandRequiredstringdata.commandgetTradebill
bill_dateRequiredstringdata.bill_dateBill date in dd-MM-yyyy format. Download requests are supported only for bills from the past three months.
nonce_stringRequiredstringdata.nonce_stringRandom string, no longer than 32 characters

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

This API retrieves YabandPay clearing reports.

Tip

  1. 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.
  1. 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.
  1. Only merchant super administrator accounts can call this API. Operator and cashier accounts are not authorized to call it.
ParameterTypeDescriptionRequired
userStringUID of the super administrator accountRequired
signStringSignatureRequired
methodStringv3.GetTradebillRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
commandStringgetTradebillRequired
bill_dateStringBill date in dd-MM-yyyy format. Download requests are supported only for bills from the past three months.Required
nonce_stringStringRandom string, no longer than 32 charactersRequired

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:
ParameterTypeDescription
time_zoneStringClearing time zone, usually the time zone of the merchant's country of registration
MIDStringMerchant's MID
merchant_nameStringMerchant name
store_nameStringMerchant store name
sub_pay_methodStringPayment method
settlement_currencyStringSettlement currency, ISO 4217
number_of_paymentStringNumber of payment transactions
amount_of_paymentStringTotal payment transaction amount
number_of_refundStringNumber of refund transactions
amount_of_refundStringTotal refund transaction amount
feeStringTransaction fees
net_valueStringNet transaction value before VAT deduction
vatStringVAT on all transaction fees
stateStringSettlement status: processing or settled
transaction_dateStringDate the transaction occurred
due_dateStringExpected settlement date
settlement_dateStringActual settlement date
clearing_idStringClearing ID
countStringNumber of records returned