API REFERENCE
Opname
Deze API neemt geld op van het YabandPay-walletsaldo.
Tip
- Het opnamebedrag mag het besteedbare saldo (beschikbare saldo) niet overschrijden.
- 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.MerchantBalance | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| command | String | payout | Verplicht |
| amount | String | Opnamebedrag met 2 decimalen, bijvoorbeeld 19.99 | Verplicht |
| currency | String | ISO 4217-valutacode, bijvoorbeeld EUR of CHF | Verplicht |
| reference | String | Remarks | Verplicht |
| notify_url | String | URL voor asynchrone melding | Verplicht |
| nonce_string | String | Willekeurige tekenreeks van maximaal 32 tekens | Verplicht |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"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"
Onderteken stringA met secret_key
De gegenereerde handtekening is:
"YOUR_SIGNATURE"
Voorbeeld van een aanvraag:
{
"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"
}
}
Voorbeeld van een antwoord:
{
"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": ""
}
Aanvullende informatie:
Beschrijving van antwoordparameters:
| Parameter | Type | Beschrijving |
|---|---|---|
| user | String | UID van het superbeheerderaccount |
| time | String | Huidige tijdstempel |
| gateway_name | String | Naam van de walletinstelling |
| payout_id | String | Nummer van de uitbetalingsopdracht |
| currency | String | Valutacode, ISO 4217 |
| amount | String | Opnamebedrag |
| reference | String | Remarks |
| notify_url | String | URL voor asynchrone melding |
| state | String | Orderstatus. Er zijn momenteel 6 statussen: awaiting approval, pending, failed, completed, declined, cancelled |
