API REFERENCE
Retirada de fondos
Parámetros
| Parameter | Type | Descripción | Obligatorio |
|---|---|---|---|
| data.command | string | payout | ✓ |
| data.amount | number | 提款金额,2位小数,例如19.99 | ✓ |
| data.currency | string | 货币代码,ISO 4217,例如EUR,CHF | ✓ |
| data.reference | string | 备注 | ✓ |
| data.notify_url | string | 异步通知地址 | ✓ |
| data.nonce_string | string | 随机字符串,不长于32位 | ✓ |
Esta API retira fondos del saldo de la cartera de YabandPay.
Consejo
- El importe de retirada no debe superar el saldo desponible para gastar (usable).
- 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ámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| user | String | UID de la cuenta de superadminestrador | Obligatorio |
| sign | String | Signature | Obligatorio |
| method | String | v3.MerchantBalance | Obligatorio |
| time | Long | Timestamp | Obligatorio |
- Parámetros
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| command | String | payout | Obligatorio |
| amount | String | Importe de retirada con 2 decimales; por ejemplo, 19.99 | Obligatorio |
| currency | String | ISO 4217 código de moneda, como EUR o CHF | Obligatorio |
| reference | String | Remarks | Obligatorio |
| notify_url | String | URL de notificación asíncrona | Obligatorio |
| nonce_string | String | Cadena aleatoria de un máximo de 32 caracteres | Obligatorio |
Ejemplo de firma:
Parámetros ordenados y concatenados en una cadena de consulta con formato de URL
"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"
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ámetro | Tipo | Descripción |
|---|---|---|
| user | String | UID de la cuenta de superadminestrador |
| time | String | Marca de tiempo actual |
| gateway_name | String | Nombre de la entidad de la cartera |
| payout_id | String | número de orden de retirada |
| currency | String | Código de moneda ISO 4217 |
| amount | String | Importe de retirada |
| reference | String | Remarks |
| notify_url | String | URL de notificación asíncrona |
| state | String | Estado del pedido. Actualmente hay 6 estados: awaiting approval, pending, failed, completed, declined, cancelled |
