Documentatie/API-referentie

API REFERENCE

Verrekeningsrapporten

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

Verrekeningsrapporten

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

Request parameters3

Required fields first

清算报表

commandRequiredstringdata.commandgetTradebill
bill_dateRequiredstringdata.bill_date账单日期 格式dd-MM-yyyy 仅支持三个月内的账单下载申请。
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位

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

Deze API haalt de verrekeningsrapporten van YabandPay op.

Tip

  1. YabandPay verrekent dagelijks om 4 uur 's ochtends (Nederlandse tijd) alle transacties van de vorige dag en genereert vervolgens de rapporten. We raden aan de rapporten na 7 uur Nederlandse tijd op te vragen.
  1. Voor elke winkel en betaalmethode wordt dagelijks een verrekeningsrapport gegenereerd. Een winkel met bijvoorbeeld twee betaalmethoden ontvangt 2 rapporten per dag.
  1. Alleen superbeheerderaccounts van merchants mogen deze API aanroepen. Operator- en kassieraccounts zijn niet bevoegd.

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

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.GetTradebillVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
commandStringgetTradebillVerplicht
bill_dateStringFactuurdatum in dd-MM-yyyy-notatie. Alleen downloadaanvragen voor facturen van de afgelopen drie maanden worden ondersteund.Verplicht
nonce_stringStringWillekeurige tekenreeks van maximaal 32 tekensVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

"bill_date=2024-02-19&command=getTradebill&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

{
  "user": "040268",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.GetTradebill",
  "time": 1708422208,
  "data": {
    "command": "getTradebill",
    "bill_date": "19-02-2024",
    "nonce_string": "tw5be5b7sry5prm96s"

  }
}

Voorbeeld van een antwoord:

{
	"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
    }
}

Aanvullende informatie:

Beschrijving van antwoordparameters:
ParameterTypeBeschrijving
time_zoneStringTijdzone van de verrekening, doorgaans de tijdzone van het land waar de merchant is geregistreerd
MIDStringMID van de merchant
merchant_nameStringNaam van de merchant
store_nameStringNaam van de merchantwinkel
sub_pay_methodStringBetaalmethode
settlement_currencyStringVerrekeningsvaluta, ISO 4217
number_of_paymentStringAantal betalingstransacties
amount_of_paymentStringTotaalbedrag van betalingstransacties
number_of_refundStringAantal terugbetalingstransacties
amount_of_refundStringTotaalbedrag van terugbetalingstransacties
feeStringTransactiekosten
net_valueStringNettotransactiewaarde vóór aftrek van btw
vatStringBtw over alle transactiekosten
stateStringVerrekeningsstatus: processing of settled
transaction_dateStringDatum waarop de transactie heeft plaatsgevonden
due_dateStringVerwachte verrekendatum
settlement_dateStringWerkelijke verrekendatum
clearing_idStringVerrekenings-ID
countStringAantal geretourneerde records