API REFERENCE
Auszahlung
Diese API hebt Geld vom YabandPay-Walletguthaben ab.
Tipp
- Der Auszahlungsbetrag darf das verfügbare Guthaben (usable) nicht überschreiten.
- 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.MerchantBalance | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| command | String | payout | Erforderlich |
| amount | String | Auszahlungsbetrag mit 2 Dezimalstellen, zum Beispiel 19.99 | Erforderlich |
| currency | String | ISO-4217-Währungscode, z. B. EUR oder CHF | Erforderlich |
| reference | String | Remarks | Erforderlich |
| notify_url | String | URL für asynchrone Benachrichtigungen | Erforderlich |
| nonce_string | String | Zufällige Zeichenfolge mit höchstens 32 Zeichen | Erforderlich |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"amount=100.01&command=payout¤cy=EUR&method=v3.MerchantBalance&nonce_string=2yx20x4c6dswedikxs¬ify_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:
| Parameter | Typ | Beschreibung |
|---|---|---|
| user | String | UID des Superadmin-Kontos |
| time | String | Aktueller Zeitstempel |
| gateway_name | String | Name des Wallet-Anbieters |
| payout_id | String | Auszahlungsauftragsnummer |
| currency | String | Währungscode, ISO 4217 |
| amount | String | Auszahlungsbetrag |
| reference | String | Remarks |
| notify_url | String | URL für asynchrone Benachrichtigungen |
| state | String | Auftragsstatus. Derzeit gibt es 6 Statuswerte: awaiting approval, pending, failed, completed, declined, cancelled |
