Documentación/Referencia de API

API REFERENCE

Captura de autorización

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

Captura de autorización

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters6

Required fields first

预授权请款

trade_idRequiredstringdata.trade_id对应预授权的trade_id
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Parámetros

ParameterTypeDescripciónObligatorio
data.trade_idstring对应预授权的trade_id✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Se aplica a: captura tras la autorización

Capture el pedido después de una autorización correcta. La captura debe realizarse en un plazo de 30 días desde la finalización de la autorización; de lo contrario, la autorización caduca automáticamente.

La moneda de la captura debe coincidir con la moneda de autorización y el importe no puede superar el importe autorizado originalmente.

Solo se admite una captura por cada transacción autorizada. No se admiten varias capturas.

ParámetroTipoDescripciónObligatorio
userStringCashier account UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CaptureObligatorio
timeLongTimestampObligatorio
  • Parameters
ParámetroTipoDescripciónObligatorio
trade_idStringtrade_id of the authorizationObligatorio
amountStringAmount as a numeric string. For example, enter 24.99 for € 24.99.Obligatorio
currencyStringISO 4217 currency code, for example EUR or CHFObligatorio
descriptionStringOrder descriptionObligatorio
notify_urlStringAsynchronous notification URL after paymentObligatorio
request_idStringUnique request ID; a combination of digits and letters at least 24 characters is recommendedObligatorio

Signature example:

Sorted parameters concatenated into a URL-style query string

"amount=1&currency=EUR&description=test&method=v3.Capture&notify_url=https://www.yabandpay.com/notify&request_id=ca51f2fas3i0f8uiw7efj6oe4i2w1ghj&time=1720684254&trade_id=160899f3-f6d9-a8d8-ab5b-82eacdab9c5b&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.Capture",
    "time": 1720684254,
    "data": {
        "description": "test",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "1",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "ca51f2fas3i0f8uiw7efj6oe4i2w1ghj"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "1",
        "currency": "EUR",
        "state": "paid"},
    "message": "",
    "response_id": "202407111550570060848432"
}

Additional information:

Response result:
  1. A successful request returns "status": true.

  2. A failed request returns "status": false.

Recomendamos encarecidamente utilizar tanto Consulta de pedido como Notificaciones asíncronas para mantener los estados de pago precisos y actualizados.

Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4089Exceed capture window
false-4084The captured amount exceeds the original authorized amount
false-4085The captured currency is different from the original authorization currency
false-4024The original trade ID is incorrect