Documentatie/API-referentie

API REFERENCE

Opname

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

Opname

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.

Deze API neemt geld op van het YabandPay-walletsaldo.

Tip

  1. Het opnamebedrag mag het besteedbare saldo (beschikbare saldo) niet overschrijden.
  1. 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

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.MerchantBalanceVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
commandStringpayoutVerplicht
amountStringOpnamebedrag met 2 decimalen, bijvoorbeeld 19.99Verplicht
currencyStringISO 4217-valutacode, bijvoorbeeld EUR of CHFVerplicht
referenceStringRemarksVerplicht
notify_urlStringURL voor asynchrone meldingVerplicht
nonce_stringStringWillekeurige tekenreeks van maximaal 32 tekensVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

"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"

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:
ParameterTypeBeschrijving
userStringUID van het superbeheerderaccount
timeStringHuidige tijdstempel
gateway_nameStringNaam van de walletinstelling
payout_idStringNummer van de uitbetalingsopdracht
currencyStringValutacode, ISO 4217
amountStringOpnamebedrag
referenceStringRemarks
notify_urlStringURL voor asynchrone melding
stateStringOrderstatus. Er zijn momenteel 6 statussen: awaiting approval, pending, failed, completed, declined, cancelled