API REFERENCE
Pagamento rápido
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.pay_method | string | offline | ✓ |
| data.sub_pay_method | string | WeChat Pay,Alipay,UnionPay QRcode,通过接口[获取sub pay method](/yabandpay/docs/v3-cn/payments/simplepay/subpaymethod) 获取。**如果为空(推荐),将由YabandPay来做支付方式判断。** | — |
| data.order_id | string | 商户订单号 | ✓ |
| data.amount | string | 金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1 | ✓ |
| data.tip_amount | string | 总金额中包含的小费,金额数字。例如 1.02 | — |
| data.currency | string | 货币代码,ISO 4217,例如EUR,CHF | ✓ |
| data.demo | string | 自定义字段 | — |
| data.auth_code | string | 微信支付或者支付宝+钱包的授权码 | ✓ |
| data.description | string | 订单描述 | ✓ |
| data.notify_url | string | 支付完成后异步通知地址 | — |
Para pagamentos em lojas físicas, com suporte a WeChat Pay e Alipay+.
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | Conta de caixa UID | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.BarcodePayment | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parâmetros
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| pay_method | String | offline | Obrigatório |
| sub_pay_method | String | WeChat Pay,Alipay,UnionPay QRcode. Obtenha-o por meio de Get sub pay method. Se deixado em branco (recomendado), a YabandPay identifica o método de pagamento. | Opcional |
| order_id | String | ID do pedido do estabelecimento | Obrigatório |
| amount | String | Valor como cadeia numérica. Por exemplo, informe 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1. | Obrigatório |
| tip_amount | String | Gorjeta incluída no valor total, como cadeia numérica; por exemplo, 1.02 | Opcional |
| currency | String | Código da moeda ISO 4217 currency code, for example EUR or CHF | Obrigatório |
| demo | String | Campo personalizado | Opcional |
| auth_code | String | Código de autorização da carteira WeChat Pay ou Alipay+ | Obrigatório |
| description | String | Descrição do pedido | Obrigatório |
| notify_url | String | URL de notificação assíncrona após o pagamento | Opcional |
Exemplo de assinatura:
Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL
"amount=2.1&auth_code=134443133735495918¤cy=EUR&demo=test&description=YabandPay test&method=v3.BarcodePayment¬ify_url=https://www.yabandpay.com/notify&order_id=202488465489451317&pay_method=offline&sub_pay_method=WeChat Pay&time=1555499083&tip_amount=0.5&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.BarcodePayment",
"time": 1555499083,
"data": {
"amount": "2.1",
"tip_amount": "0.5",
"auth_code": "YOUR_AUTH_CODE",
"currency": "EUR",
"demo": "test",
"description": "YabandPay test",
"notify_url": "https://www.yabandpay.com/notify",
"order_id": "YOUR_ORDER_ID",
"pay_method": "offline",
"sub_pay_method": "WeChat Pay"
}
}
Exemplo de resposta:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "511444d0-2d91-5396-9e34-f2900e80d715",
"amount": "2.1",
"tip_amount": "0.5",
"sub_pay_method": "WeChat Pay",
"state": "paid"
},
"message": ""}
Informações adicionais:
Resultado da resposta:
Dica
- Se o cliente não precisar inserir uma senha, o resultado do pagamento será retornado de forma síncrona.
- Se o cliente precisar inserir uma senha após a leitura do código, o resultado do pagamento será state: processing. O estabelecimento deve consultar Query Order a cada 5 segundos para determinar o resultado real do pagamento.
- Se o cliente cancelar ou não pagar dentro de 30 segundos, recomendamos sair do ciclo de consulta e chamar Cancel Payment para reverter a transação de pagamento. Se o cliente já tiver pago, o sistema emitirá um reembolso automaticamente.
Códigos de resposta:
| Status | Code | Message |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -1007 | Identity code is invalid |
| false | -4011 | Not support the payment method |
| false | -4015 | This order has been closed |
| false | -4028 | WeChat Pay is not available |
| false | -4029 | Alipay is not available |
| false | -4086 | Unknow identity code |
