Documentación/Referencia de API

API REFERENCE

CardCheck

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

CardCheck

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

Request parameters10

Required fields first

CardCheck

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCardCheck
operationRequiredstringdata.operation3
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 3
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

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

Parámetros

ParameterTypeDescripciónObligatorio
data.pay_methodstringonline✓
data.sub_pay_methodstringCardCheck✓
data.operationstring3✓
data.order_idstring商户的订单ID✓
data.descriptionstring订单描述✓
data.form_typestring返回的url类型,默认01。 01.completed, 02.iframe—
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Initiate a 0-value authorization for the cardholder to validate the supplied card number. The cardholder must provide valid information to complete verification.

La verificación puede completarse mediante la página alojada por YabandPay. Los comercios pueden aceptar solicitudes de forma segura al alojar los datos sensibles sujetos a PCI DSS en el sistema de YabandPay.

Consejo

Obtain the verification result through Consulta de pedido.

ParámetroTipoDescripciónObligatorio
userStringCuenta de cajero UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CardCheckObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
pay_methodStringonlineObligatorio
sub_pay_methodStringCardCheckObligatorio
operationString3Obligatorio
order_idStringID de pedido del comercioObligatorio
descriptionStringDescripción del pedidoObligatorio
form_typeStringType of returned url; defaults to 01. 01.completed, 02.iframeOpcional
demoStringCampo personalizadoOpcional
timeoutStringTiempo de expiración en minutos (0-1440)Obligatorio
redirect_urlStringURL de redirección tras el pagoOpcional
notify_urlStringURL de notificación asíncrona tras el pagoObligatorio
request_idStringID de solicitud único; se recomienda una combinación de letras y números de al menos 24 caracteresObligatorio

Ejemplo de firma:

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

"description=cardcheck test&form_type=01&method=v3.CardCheck&notify_url=https://www.yabandpay.com/notify&operation=3&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=CardCheck&time=1720680417&timeout=0&user=YOUR_CASHIER_UID"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CardCheck",
    "time": 1720680417,
    "data": {
        "description": "cardcheck test",
        "form_type": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "CardCheck",
        "operation": "3",
        "order_id": "YOUR_ORDER_ID",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Ejemplo de respuesta:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "0.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
        "state": "processing"
    },
    "message": "",
    "response_id": "202407111544200649155078"
}

Información adicional:

Resultado de la respuesta:
  1. Una solicitud correcta devuelve "status": true.

  2. Una solicitud fallida devuelve "status": false.

Redirect to the returned url. After the user enters card details at this url and completes payment, they are redirected back to redirect_url synchronously. Recomendamos encarecidamente utilizar tanto Consulta de pedido and Notificaciones asíncronas to synchronize and update the payment status and keep payment information accurate in real time. a) If the order status state is paid, payment succeeded;

Códigos de respuesta:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID