API REFERENCE

Solução de pagamento hospedada (HPP)

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	List	✓
data.order_id	string	商户的订单ID	✓
data.operation	string	1.Sales 2.Authorisation；	✓
data.amount	string	金额数字。例如 € 24.99 应该写成24.99，CNY金额>=1，欧元金额>=0.1（iDeal支付、Sofort支付、PayPal支付，欧元金额>=1）	✓
data.currency	string	货币代码，ISO 4217，例如EUR，CHF	✓
data.description	string	订单描述	✓
data.demo	string	自定义字段	—
data.timeout	string	过期时间单位分钟(0-1440)	✓
data.redirect_url	string	支付完成后跳转地址	—
data.notify_url	string	支付完成后异步通知地址	✓

Métodos de pagamento compatíveis: todos os métodos de pagamento

Esta solução Hosted Payment Page (HPP) hospeda o checkout na YabandPay, onde os clientes selecionam um método e pagam. Os estabelecimentos precisam integrar somente este checkout, em vez de cada método individualmente, simplificando a gestão e futuras atualizações.

Parâmetro	Tipo	Descrição	Obrigatório
user	String	Conta de caixa UID	Obrigatório
sign	String	Signature	Obrigatório
method	String	v3.CreatePayments	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	List	Obrigatório
order_id	String	ID do pedido do estabelecimento	Obrigatório
operation	String	1.Sales 2.Authorisation；	Obrigatório
amount	String	Valor como cadeia numérica. Por exemplo, informe 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1 (for iDeal, Sofort, and PayPal, EUR amount >=1).	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
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

Exemplo de assinatura:

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

 "amount=1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=20248746132489&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=List&time=1546588900&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.CreatePayments",
    "time": 1546588900,
    "data": {
        "description": "YabandPay test",
        "timeout": "0",
        "operation": "1",
        "pay_method": "online",
        "sub_pay_method": "List",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com",
        "notify_url": "https://www.yabandpay.com/notify",
        "demo": "test"
    }
}

Exemplo de resposta:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "b769e338-20e7-35fa-dbb4-986892b96079",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/SelectPay/Yjc2OWUzMzgtMjBlNy0zNWZhLWRiYjQtOTg2ODkyYjk2MDc5",
        "state": "processing"
    },
    "message": ""
}

Informações adicionais:

Resultado da resposta:

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

Recomendamos fortemente usar Query Order e Asynchronous Notifications para manter os status de pagamento corretos e atualizados.

Códigos de resposta:

Status	Code	Message
true	200	Success
false	-1000	Internal error
false	-3001	Required field is missing
false	-403	The signature Error
false	-4011	Not support the payment method