API REFERENCE

Página de pagamento hospedada

YabandPay documentation·Atualizado em 26 de out. de 2026

Parâmetros

Parameter	Type	Descrição	Obrigatório
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 autorizações de cartão e compras diretas

A Hosted Payment Page (HPP) da YabandPay é uma página de pagamento pronta para uso e totalmente mantida pela YabandPay. Os estabelecimentos podem aceitar pagamentos com segurança, mantendo os dados confidenciais sujeitos ao PCI no sistema da YabandPay. O formulário pode ser incorporado ao fluxo de checkout do estabelecimento como um iframe ou uma página de redirecionamento.

Dica

As autorizações são válidas por 30 dias. As ordens de autorização expiram automaticamente após 30 dias.

Parâmetro	Tipo	Descrição	Obrigatório
user	String	Conta de caixa UID	Obrigatório
sign	String	Signature	Obrigatório
method	String	v3.CreateCardPayments	Obrigatório
time	Long	Timestamp	Obrigatório

Parâmetros

Parâmetro	Tipo	Descrição	Obrigatório
pay_method	String	online	Obrigatório
sub_pay_method	String	Cards HPP	Obrigatório
operation	String	1.Sales 2.Authorisation；	Obrigatório
order_id	String	ID do pedido do estabelecimento	Obrigatório
3ds_initiate	String	01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).	Obrigatório
sca_exemption	String	LowValue	Obrigatório quando 3ds_initiate=03
amount	String	Valor como cadeia numérica. Por exemplo, informe 24.99 for € 24.99.	Obrigatório
currency	String	Código da moeda ISO 4217 currency code, for example EUR or CHF	Obrigatório
description	String	Descrição do pedido	Obrigatório
form_type	String	Type of returned url; defaults to 01. 01.completed, 02.iframe	Opcional
email	string	E-mail do titular do cartão	Obrigatório
demo	String	Campo personalizado	Opcional
timeout	String	Tempo de expiração em minutos (0-1440)	Obrigatório
redirect_url	String	URL de redirecionamento após o pagamento	Opcional
notify_url	String	URL de notificação assíncrona após o pagamento	Obrigatório
request_id	String	ID de solicitação exclusivo; recomenda-se uma combinação de letras e números com pelo menos 24 characters is recommended	Obrigatório

Exemplo de assinatura:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

"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"

Assine a stringA usando secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Exemplo de solicitação:

{
    "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"
    }
}

Exemplo de resposta:

{
    "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"
}

Informações adicionais:

Resultado da resposta:

Uma solicitação bem-sucedida retorna "status": true.
Uma solicitação malsucedida retorna "status": false.

Redirecione o cliente para url, que foi retornado. Depois de inserir os dados do cartão e concluir o pagamento, o cliente será redirecionado para redirect_url. Recomendamos fortemente usar Query Order e Asynchronous Notifications para manter os status de pagamento corretos e atualizados. a) Um pedido state of paid indica um pagamento bem-sucedido. b) Um pedido state of authorized indica uma autorização bem-sucedida. Para capturar um pagamento autorizado, chame a API Capture Authorization.

Códigos de resposta:

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 pagamento hospedada