Documentación/Referencia de API

API REFERENCE

Retirada de fondos

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

Retirada de fondos

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.

Parámetros

ParameterTypeDescripciónObligatorio
data.commandstringpayout✓
data.amountnumber提款金额,2位小数,例如19.99✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.referencestring备注✓
data.notify_urlstring异步通知地址✓
data.nonce_stringstring随机字符串,不长于32位✓

Esta API retira fondos del saldo de la cartera de YabandPay.

Consejo

  1. El importe de retirada no debe superar el saldo desponible para gastar (usable).
  1. Solo las cuentas de superadminestrador del comercio pueden llamar a esta API. Las cuentas de operador y cajero no tienen autorización para hacerlo.
ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.MerchantBalanceObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringpayoutObligatorio
amountStringImporte de retirada con 2 decimales; por ejemplo, 19.99Obligatorio
currencyStringISO 4217 código de moneda, como EUR o CHFObligatorio
referenceStringRemarksObligatorio
notify_urlStringURL de notificación asíncronaObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

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

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

Ejemplo de respuesta:

{
    "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": ""
}

Información adicional:

Descripción de los parámetros de respuesta:
ParámetroTipoDescripción
userStringUID de la cuenta de superadminestrador
timeStringMarca de tiempo actual
gateway_nameStringNombre de la entidad de la cartera
payout_idStringnúmero de orden de retirada
currencyStringCódigo de moneda ISO 4217
amountStringImporte de retirada
referenceStringRemarks
notify_urlStringURL de notificación asíncrona
stateStringEstado del pedido. Actualmente hay 6 estados: awaiting approval, pending, failed, completed, declined, cancelled