Documentación/Referencia de API

API REFERENCE

Obtener token (integración directa)

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

Obtener token (integración directa)

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

Request parameters14

Required fields first

获取Token(Card)

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCard
operationRequiredstringdata.operation10.Create Token only; 11.Token for sales; 12.Token for authorisation
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0
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 3
cardinfoOptionalstringdata.cardinfo卡信息
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiateRequiredstringdata.3ds_initiate3ds设置。 01. 必须开启3ds验证;

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_methodstringCard✓
data.operationstring10.Create Token only; 11.Token for sales; 12.Token for authorisation✓
data.order_idinteger商户的订单ID✓
data.cardinfostring卡信息—
data.amountstring金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.emailstring持卡人email✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.3ds_initiatestring3ds设置。 01. 必须开启3ds验证;✓
data.sca_exemptionstringSCA 豁免类型;样例中的该字段受 3DS 模式约束。✓

Se aplica a: comercios e instituciones certificados según PCI DSS

Utilice esta API para completar un pago de extremo a extremo (la verificación 3DS es obligatoria). YabandPay convierte los datos confidenciales del titular en una cadena aleatoria (un token) para eliminar la información identificativa. El token puede utilizarse para los siguientes pagos:

  1. Los usuarios pueden pagar con un solo clic en la página de pago sin introducir los datos de la tarjeta de crédito.
  2. Los comercios pueden utilizar este token para pagos recurrentes, cargos de suscripción y otros fines similares.

[!TIP|style:flat] Workflow

  1. Active los pagos con token. Póngase en contacto con su gestor de cuenta para habilitar esta función.
  1. Obtenga el consentimiento del usuario. Al habilitar pagos exprés (pagos con token) para consumidores, debe informarles claramente y obtener su consentimiento para evitar posibles disputas.
  1. Get a Token. First, initiate a standard credit card transaction. YabandPay returns a url. After the user completes 3DS verification through that url, YabandPay returns the Token in an asynchronous notification using the payment_token_object parameter.
  1. Inicie un pago con token. Incluya el token en la payment_token_object variable. If Token validation succeeds, YabandPay processes the Token payment. If validation fails, YabandPay returns an error. In that case, we recommend repeating this transaction flow to obtain a Token and then initiating payment again.
ParámetroTipoDescripciónObligatorio
userStringCashier account UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CreateCardPaymentsObligatorio
timeLongTimestampObligatorio
  • Parameters
ParámetroTipoDescripciónObligatorio
pay_methodStringonlineObligatorio
sub_pay_methodStringCardObligatorio
operationString10.Create Token only; 11.Token for sales; 12.Token for authorisationObligatorio
order_idStringMerchant order IDObligatorio
3ds_initiateString3ds settings. 01. 3ds verification must be enabled;Obligatorio
cardinfoStringCard informationTreat the value of cardinfo as a string (fields within cardinfo do not need to be included in 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
amountStringNumeric amount. For example, € 24.99 must be written as 24.99. If operation is 10, set amount=0Obligatorio
currencyStringISO 4217 currency code, for example EUR or CHFObligatorio
descriptionStringOrder descriptionObligatorio
emailstringCardholder emailObligatorio
demoStringCustom fieldOpcional
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","email":"JohnSmith@gmail.com","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&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"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
	"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": "11",
		"order_id": 1756878556,
		"cardinfo": "{\"card_holder\":\"John Smith\",\"card_number\":\"4356789012345670\",\"expiration_month\":\"01\",\"expiration_year\":\"2023\",\"cvc\":\"123\"}",
		"sca_exemption": "LowValue",
		"amount": "0.1",
		"currency": "EUR",
		"email": "JohnSmith@gmail.com",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
	}
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "2b2aa1af-6e97-4c01-8c52-86200bf66c82",
        "amount": "0.1",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/pay_method/Y3JlZGl0Y2FyZA==/MmIyYWExYWYtNmU5Ny00YzAxLThjNTItODYyMDBiZjY2Yzgy",
        "state": "processing"
    },
    "message": "",
    "response_id": "202409091749500451314672"
}

Additional information:

MIT & CIT :

MIT = Merchant Initiated subsequent transactions. Token payments initiated by the merchant.

CIT = Cardholder Initiated Subsequent transactions. Token payments involving the customer. When activating payments, specify whether you need MIT or CIT so the appropriate mode can be configured.

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

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

Redirija al cliente a la url. After entering card details and completing payment at this url, 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.

Returned Token:
  1. After the customer grants authorization and the payment succeeds, YabandPay returns payment_token_object through an asynchronous notification.

  2. If the customer does not grant authorization or does not complete payment, the asynchronous notification does not return payment_token_object.

3DS low-value exemption:

Transactions within the following limits may qualify as low-value transactions. If the order amount is less than or equal to the applicable amount below, transaction code 02 (low-value exemption) may be used with approval.

#CurrencyAmount
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
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-4120No operational permissions