Dokumentation/API-Referenz

API REFERENCE

Transaktionsdetails

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

Transaktionsdetails

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

Request parameters5

Required fields first

交易明细

commandRequiredstringdata.commandgetTradebillinfo
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
Optional parameters 3
clearing_idOptionalstringdata.clearing_id清算报表ID
start_timeOptionalstringdata.start_time交易开始时间
end_timeOptionalstringdata.end_time交易结束时间

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

Diese API fragt Transaktionsdetails in YabandPay-Abrechnungsberichten oder anhand eines Transaktionszeitraums ab.

Tipp

  1. Transaktionsdetails enthalten nur Transaktionen mit Geldabrechnung, etwa erfolgreiche Zahlungen oder Rückerstattungen. Stornierungen und Autorisierungen sind nicht enthalten.
  1. Bei der Abfrage nach Zeitraum darf der Zeitraum höchstens ein Jahr umfassen.
  1. Transaktionen, die älter als 7 Jahre sind, können nicht abgefragt werden.
  1. Diese API kann nur vom Superadmin-Konto des Händlers aufgerufen werden. Bediener- und Kassiererkonten sind dazu nicht berechtigt.
ParameterTypBeschreibungErforderlich
userStringUID des Superadmin-KontosErforderlich
signStringSignatureErforderlich
methodStringv3.GetTradebillErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
commandStringgetTradebillinfoErforderlich
clearing_idStringID des AbrechnungsberichtsOptional
start_timeStringBeginn der TransaktionOptional
end_timeStringEnde der TransaktionOptional
nonce_stringStringZufällige Zeichenfolge mit höchstens 32 ZeichenErforderlich

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:
ParameterTypBeschreibung
time_zoneStringAbrechnungszeitzone, normalerweise die Zeitzone des Registrierungslands des Händlers
store_nameStringName des Händlergeschäfts
dateStringDatum des Transaktionsabschlusses
settlement_currencyStringAbrechnungswährung, ISO 4217
amountStringAbrechnungsbetrag
feeStringTransaktionsgebühren
net_valueStringNettobetrag vor Abzug der MwSt.
vatStringMwSt. auf Gebühren
typeStringTransaktionstyp: Payment oder Refund
sub_pay_methodStringZahlungsmethode
order_idStringHändler-Transaktions-ID
trade_idStringYabandPay-Transaktions-ID
descriptionStringTransaktionsbeschreibung
demoStringVom Händler definierter Wert
stateStringTransaktionsstatus: Paid oder Refunded
fund_flow_statusStringStatuscode der Geldbewegung
fund_flow_descriptionStringBeschreibung des Status der Geldbewegung
countStringAnzahl der zurückgegebenen Datensätze
Statuscodes und Beschreibungen der Geldbewegung:
fund_flow_statusfund_flow_description
0uncleared
1cleared
2settled