API REFERENCE
Transactiegegevens
Deze API vraagt transactiegegevens op uit YabandPay-verrekeningsrapporten of op basis van een transactiedatumperiode.
Tip
- Transactiegegevens bevatten alleen transacties waarbij geld wordt verrekend, zoals geslaagde betalingen of terugbetalingen. Annuleringen en autorisaties zijn uitgesloten.
- Bij het opvragen op basis van een datumperiode mag deze periode maximaal één jaar beslaan.
- Transacties van meer dan 7 jaar geleden kunnen niet worden opgevraagd.
- 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
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| user | String | UID van het superbeheerderaccount | Verplicht |
| sign | String | Signature | Verplicht |
| method | String | v3.GetTradebill | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| command | String | getTradebillinfo | Verplicht |
| clearing_id | String | ID van het verrekeningsrapport | Optioneel |
| start_time | String | Begintijd van de transactie | Optioneel |
| end_time | String | Eindtijd van de transactie | Optioneel |
| nonce_string | String | Willekeurige tekenreeks van maximaal 32 tekens | Verplicht |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"clearing_id=M20240302001503350733&command=getTradebillinfo&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 - verrekeningsrapport:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"clearing_id": "M20240220001503109569",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Voorbeeld van een aanvraag - datumperiode:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"start_time": "1716393600",
"end_time" : "1716566340",
"nonce_string": "g46a5g156rt4784ghb1b"
}
}
Voorbeeld van een antwoord:
{
"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": "YOUR_ORDER_ID",
"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": "YOUR_ORDER_ID",
"trade_id": "ed71a5db-8e1c-a883-d062-ccbb4005b914",
"description": "test order",
"demo": "",
"state": "paid",
"fund_flow_status": "2",
"fund_flow_description": "settled"}
],
"count": 2
}
}
Aanvullende informatie:
Beschrijving van antwoordparameters:
| Parameter | Type | Beschrijving |
|---|---|---|
| time_zone | String | Tijdzone van de verrekening, doorgaans de tijdzone van het land waar de merchant is geregistreerd |
| store_name | String | Naam van de merchantwinkel |
| date | String | Datum waarop de transactie is voltooid |
| settlement_currency | String | Verrekeningsvaluta, ISO 4217 |
| amount | String | Verrekend bedrag |
| fee | String | Transactiekosten |
| net_value | String | Nettobedrag vóór aftrek van btw |
| vat | String | Btw over de kosten |
| type | String | Transactietype: Payment of Refund |
| sub_pay_method | String | Betaalmethode |
| order_id | String | Transactie-ID van de merchant |
| trade_id | String | Transactie-ID van YabandPay |
| description | String | Transactieomschrijving |
| demo | String | Door de merchant gedefinieerd veld |
| state | String | Transactiestatus: Paid of Refunded |
| fund_flow_status | String | Statuscode van de geldmiddelen |
| fund_flow_description | String | Statusbeschrijving van de geldmiddelen |
| count | String | Aantal geretourneerde records |
Statuscodes en beschrijvingen van geldmiddelen:
| fund_flow_status | fund_flow_description |
|---|---|
| 0 | nog niet verrekend |
| 1 | verrekend |
| 2 | afgerekend |