Documentación/Referencia de API

API REFERENCE

Pago con tarjeta

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

Pago con tarjeta

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

Request parameters15

Required fields first

Card Payment

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCard
operationRequiredstringdata.operation1.Sales 2.Authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
emailRequiredstringdata.email持卡人email
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 4
payment_token_objectChoose onestringdata.payment_token_object从YabandPay支付插件获得的字符串cardinfo和payment_token_object二选一
cardinfoChoose onestringdata.cardinfo卡信息cardinfo和payment_token_object二选一,cardinfo的值作为string处理(cardinfo内的字段不用加入排序)
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiateRequiredstringdata.3ds_initiate01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);

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

Para autorizaciones de tarjeta y compras directas

Esta API está destinada a clientes que introducen los datos de su tarjeta en la página del comercio, en lugar de en una página alojada por YabandPay a la que se les redirija. Tenga en cuenta lo siguiente:

  1. Los comercios certificados según PCI DSS y capaces de gestionar de forma segura los datos del titular pueden crear su propio formulario de tarjeta y enviar los datos mediante cardinfo.

  2. Si el comercio recopila los datos de tarjeta mediante el complemento de frontend de YabandPay (contacte con YabandPay para obtener instrucciones de integración), el complemento devuelve un valor cifrado de un solo uso payment_token_object for the subsequent payment request.

Consejo

Las autorizaciones son válidas durante 30 días. Las órdenes de autorización caducan automáticamente después de 30 days.

ParámetroTipoDescripciónObligatorio
userStringCashier account UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CreateCardPaymentsObligatorio
timeLongTimestampObligatorio
  • Parameters
ParámetroTipoDescripciónObligatorio
pay_methodStringonlineObligatorio
sub_pay_methodStringCardObligatorio
operationString1.Sales 2.Authorisation;Obligatorio
order_idStringMerchant order IDObligatorio
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Obligatorio
sca_exemptionStringLowValueRequired when 3ds_initiate=03
payment_token_objectStringString obtained from the YabandPay payment pluginProvide either cardinfo or payment_token_object
cardinfoStringCard informationProvide either cardinfo or payment_token_object. Treat cardinfo as a string (do not include the fields inside cardinfo in the parameter sorting).
cardinfo.card_holderstringCardholder nameObligatorio
cardinfo.card_numberstringCard numberObligatorio
cardinfo.expiration_monthstringCard expiration month, MMObligatorio
cardinfo.expiration_yearstringCard expiration year, YYYYObligatorio
cardinfo.cvcstringCVC (storing the CVC in any form violates PCI DSS requirements)Obligatorio
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
demoStringCustom fieldOpcional
emailstringCardholder emailObligatorio
timeoutStringExpiration time in minutes (0-1440)Obligatorio
redirect_urlStringRedirect URL after paymentOpcional
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

”3ds_initiate=01&amount=0.1&cardinfo={"card_holder":"John Smith","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}&currency=EUR&description=test&email=JohnSmith@gmail.com&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=1756878556&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&sca_exemption=LowValue&sub_pay_method=Card&time=1756878556&timeout=0&user=YOUR_CASHIER_UID“

Request example using cardinfo:


{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CreateCardPayments",
	"time": 1756878556,
	"data": {
		"description": "test",
		"3ds_initiate": "01",
		"timeout": "0",
		"pay_method": "online",
		"sub_pay_method": "Card",
		"operation": "1",
		"order_id": 1756878556,
		"cardinfo": "{\"card_holder\":\"John Smith\",\"card_number\":\"4356789012345670\",\"expiration_month\":\"01\",\"expiration_year\":\"2023\",\"cvc\":\"123\"}",
		"sca_exemption": "LowValue",
        "email": "JohnSmith@gmail.com",
		"amount": "0.1",
		"currency": "EUR",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
	}
}

Request example using payment_token_object:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1720680417,
    "data": {
        "payment_token_object": "4564sf65as4f5awe4ft65awe4gt65ewaa4t65ew4t65ew4t65rew4t",
        "description": "test",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Card",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Response example:

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

Additional information:

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

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

Redirija al cliente a la url. After completing 3DS there, the customer is redirected to redirect_url. Recomendamos encarecidamente utilizar tanto Consulta de pedido como Notificaciones asíncronas para mantener los estados de pago precisos y actualizados. a) An order state of paid indicates a successful payment. b) An order state of authorized indicates a successful authorization. To capture an authorized payment, call the Capture Authorization API.

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