API REFERENCE

Página de pago alojada

YabandPay documentation·Actualizado el 26 oct 2026

Parámetros

Parameter	Type	Descripción	Obligatorio
data.pay_method	string	online	✓
data.sub_pay_method	string	Cards HPP	✓
data.operation	string	1.Sales 2.Authorisation；	✓
data.order_id	string	商户的订单ID	✓
data.sca_exemption	string	LowValue	✓
data.amount	string	金额数字。例如 € 24.99 应该写成24.99	✓
data.currency	string	货币代码，ISO 4217，例如EUR，CHF	✓
data.description	string	订单描述	✓
data.form_type	string	返回的url类型，默认01。 01.completed, 02.iframe	—
data.email	string	持卡人email	✓
data.demo	string	自定义字段	—
data.timeout	string	过期时间单位分钟(0-1440)	✓
data.redirect_url	string	支付完成后跳转地址	—
data.notify_url	string	支付完成后异步通知地址	✓
data.request_id	string	请求id需保持唯一，建议24以上位数字+字母	✓
data.3ds_initiate	string	01. 开启3ds验证； 02.不开启3DS（需申请开通）；03. SCA豁免（需申请开通）；	✓

Para autorizaciones de tarjeta y compras directas

La página de pago alojada (HPP) de YabandPay es una página lista para usar y mantenida íntegramente por YabandPay. Los comercios pueden aceptar pagos de forma segura alojando los datos PCI confidenciales en el sistema de YabandPay. El formulario puede integrarse en el flujo de pago como iframe o página de redirección.

Consejo

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

Parámetro	Tipo	Descripción	Obligatorio
user	String	Cashier account UID	Obligatorio
sign	String	Signature	Obligatorio
method	String	v3.CreateCardPayments	Obligatorio
time	Long	Timestamp	Obligatorio

Parameters

Parámetro	Tipo	Descripción	Obligatorio
pay_method	String	online	Obligatorio
sub_pay_method	String	HPP de tarjetas	Obligatorio
operation	String	1.Sales 2.Authorisation；	Obligatorio
order_id	String	Merchant order ID	Obligatorio
3ds_initiate	String	01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).	Obligatorio
sca_exemption	String	LowValue	Required when 3ds_initiate=03
amount	String	Amount as a numeric string. For example, enter 24.99 for € 24.99.	Obligatorio
currency	String	ISO 4217 currency code, for example EUR or CHF	Obligatorio
description	String	Order description	Obligatorio
form_type	String	Tipo de URL devuelta; el valor predeterminado es 01. 01.completed, 02.iframe	Opcional
email	string	Cardholder email	Obligatorio
demo	String	Custom field	Opcional
timeout	String	Expiration time in minutes (0-1440)	Obligatorio
redirect_url	String	Redirect URL after payment	Opcional
notify_url	String	Asynchronous notification URL after payment	Obligatorio
request_id	String	Unique request ID; a combination of digits and letters at least 24 characters is recommended	Obligatorio

Signature example:

Sorted parameters concatenated into a URL-style query string

"3ds_initiate=01&amount=1&currency=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=Cards HPP&time=1720680417&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": 1720680417,
    "data": {
        "description": "test",
        "form_type": "01",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Cards HPP",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "email": "JohnSmith@gmail.com",
        "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:

A successful request returns "status": true.
A failed request returns "status": false.

Redirija al cliente a la url. Tras introducir los datos de la tarjeta y completar el pago allí, se redirige al cliente a 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:

Status	Code	Message
true	200
false	-1000	Internal error
false	-403	The signature Error
false	-2001	The user not exist
false	-3001	Required field is missing
false	-4118	Incorrect request ID

Página de pago alojada