API REFERENCE

Hosted Payment Page

YabandPay documentation·Updated Oct 26, 2026

For card authorizations and direct purchases

YabandPay’s Hosted Payment Page (HPP) is a ready-to-use payment page fully maintained by YabandPay. Merchants can accept payments securely by hosting sensitive PCI data within YabandPay’s system. The form can be embedded in the merchant’s checkout flow as an iframe or a redirect page.

Tip

Authorizations are valid for 30 days. Authorization orders expire automatically after 30 days.

Parameter	Type	Description	Required
user	String	Cashier account UID	Required
sign	String	Signature	Required
method	String	v3.CreateCardPayments	Required
time	Long	Timestamp	Required

Parameters

Parameter	Type	Description	Required
pay_method	String	online	Required
sub_pay_method	String	Cards HPP	Required
operation	String	1.Sales 2.Authorisation；	Required
order_id	String	Merchant order ID	Required
3ds_initiate	String	01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).	Required
sca_exemption	String	LowValue	Required when 3ds_initiate=03
amount	String	Amount as a numeric string. For example, enter 24.99 for € 24.99.	Required
currency	String	ISO 4217 currency code, for example EUR or CHF	Required
description	String	Order description	Required
form_type	String	Type of returned url; defaults to 01. 01.completed, 02.iframe	Optional
email	string	Cardholder email	Required
demo	String	Custom field	Optional
timeout	String	Expiration time in minutes (0-1440)	Required
redirect_url	String	Redirect URL after payment	Optional
notify_url	String	Asynchronous notification URL after payment	Required
request_id	String	Unique request ID; a combination of digits and letters at least 24 characters is recommended	Required

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.

Redirect the customer to the returned url. After entering card details and completing payment there, the customer is redirected to redirect_url. We strongly recommend using both Query Order and Asynchronous Notifications to keep payment statuses accurate and up to date. 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

Hosted Payment Page