Dokumentation/API-Referenz

API REFERENCE

Auszahlung

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

Auszahlung

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

Request parameters6

Required fields first

提款

commandRequiredstringdata.commandpayout
amountRequirednumberdata.amount提款金额,2位小数,例如19.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
referenceRequiredstringdata.reference备注
notify_urlRequiredstringdata.notify_url异步通知地址
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位

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

Diese API hebt Geld vom YabandPay-Walletguthaben ab.

Tipp

  1. Der Auszahlungsbetrag darf das verfügbare Guthaben (usable) nicht überschreiten.
  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.MerchantBalanceErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
commandStringpayoutErforderlich
amountStringAuszahlungsbetrag mit 2 Dezimalstellen, zum Beispiel 19.99Erforderlich
currencyStringISO-4217-Währungscode, z. B. EUR oder CHFErforderlich
referenceStringRemarksErforderlich
notify_urlStringURL für asynchrone BenachrichtigungenErforderlich
nonce_stringStringZufällige Zeichenfolge mit höchstens 32 ZeichenErforderlich

Signaturbeispiel:

Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.

"amount=100.01&command=payout&currency=EUR&method=v3.MerchantBalance&nonce_string=2yx20x4c6dswedikxs&notify_url=https://www.yabandpay.com/notify&reference=456789&time=1708482257&user=036870"

Signieren Sie stringA mit secret_key.

Die resultierende Signatur lautet:

"YOUR_SIGNATURE"

Anfragebeispiel:

{
    "user": "036870",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.MerchantBalance",
    "time": 1708482257,
    "data": {
        "command": "payout",
        "nonce_string": "2yx20x4c6dswedikxs",
        "amount": 100.01,
        "currency": "EUR",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify"
    }
}

Antwortbeispiel:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "036870",
        "time": 1708482257,
        "gateway_name": "YabandPay",
        "payout_id": "0594bf99-fce7-3784-28f7-e8e76ad01989",
        "currency": "EUR",
        "amount": "100.01",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify",
        "state": "awaiting approval"
    },
    "message": ""
}

Weitere Informationen:

Beschreibungen der Antwortparameter:
ParameterTypBeschreibung
userStringUID des Superadmin-Kontos
timeStringAktueller Zeitstempel
gateway_nameStringName des Wallet-Anbieters
payout_idStringAuszahlungsauftragsnummer
currencyStringWährungscode, ISO 4217
amountStringAuszahlungsbetrag
referenceStringRemarks
notify_urlStringURL für asynchrone Benachrichtigungen
stateStringAuftragsstatus. Derzeit gibt es 6 Statuswerte: awaiting approval, pending, failed, completed, declined, cancelled