API REFERENCE
Transaktionsdetails
Diese API fragt Transaktionsdetails in YabandPay-Abrechnungsberichten oder anhand eines Transaktionszeitraums ab.
Tipp
- Transaktionsdetails enthalten nur Transaktionen mit Geldabrechnung, etwa erfolgreiche Zahlungen oder Rückerstattungen. Stornierungen und Autorisierungen sind nicht enthalten.
- Bei der Abfrage nach Zeitraum darf der Zeitraum höchstens ein Jahr umfassen.
- Transaktionen, die älter als 7 Jahre sind, können nicht abgefragt werden.
- Diese API kann nur vom Superadmin-Konto des Händlers aufgerufen werden. Bediener- und Kassiererkonten sind dazu nicht berechtigt.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| user | String | UID des Superadmin-Kontos | Erforderlich |
| sign | String | Signature | Erforderlich |
| method | String | v3.GetTradebill | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| command | String | getTradebillinfo | Erforderlich |
| clearing_id | String | ID des Abrechnungsberichts | Optional |
| start_time | String | Beginn der Transaktion | Optional |
| end_time | String | Ende der Transaktion | Optional |
| nonce_string | String | Zufällige Zeichenfolge mit höchstens 32 Zeichen | Erforderlich |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"clearing_id=M20240302001503350733&command=getTradebillinfo&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Signieren Sie stringA mit secret_key.
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel – Abrechnungsbericht:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"clearing_id": "M20240220001503109569",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Anfragebeispiel – Zeitraum:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"start_time": "1716393600",
"end_time" : "1716566340",
"nonce_string": "g46a5g156rt4784ghb1b"
}
}
Antwortbeispiel:
{
"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
}
}
Weitere Informationen:
Beschreibungen der Antwortparameter:
| Parameter | Typ | Beschreibung |
|---|---|---|
| time_zone | String | Abrechnungszeitzone, normalerweise die Zeitzone des Registrierungslands des Händlers |
| store_name | String | Name des Händlergeschäfts |
| date | String | Datum des Transaktionsabschlusses |
| settlement_currency | String | Abrechnungswährung, ISO 4217 |
| amount | String | Abrechnungsbetrag |
| fee | String | Transaktionsgebühren |
| net_value | String | Nettobetrag vor Abzug der MwSt. |
| vat | String | MwSt. auf Gebühren |
| type | String | Transaktionstyp: Payment oder Refund |
| sub_pay_method | String | Zahlungsmethode |
| order_id | String | Händler-Transaktions-ID |
| trade_id | String | YabandPay-Transaktions-ID |
| description | String | Transaktionsbeschreibung |
| demo | String | Vom Händler definierter Wert |
| state | String | Transaktionsstatus: Paid oder Refunded |
| fund_flow_status | String | Statuscode der Geldbewegung |
| fund_flow_description | String | Beschreibung des Status der Geldbewegung |
| count | String | Anzahl der zurückgegebenen Datensätze |
Statuscodes und Beschreibungen der Geldbewegung:
| fund_flow_status | fund_flow_description |
|---|---|
| 0 | uncleared |
| 1 | cleared |
| 2 | settled |
