Documentação/Referência da API

API REFERENCE

Pagamento rápido

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Pagamento rápido

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters9

Required fields first

快捷支付

pay_methodRequiredstringdata.pay_methodoffline
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
auth_codeRequiredstringdata.auth_code微信支付或者支付宝+钱包的授权码
descriptionRequiredstringdata.description订单描述
Optional parameters 4
sub_pay_methodOptionalstringdata.sub_pay_methodWeChat Pay,Alipay,UnionPay QRcode,通过接口获取sub pay method 获取。如果为空(推荐),将由YabandPay来做支付方式判断。
tip_amountOptionalstringdata.tip_amount总金额中包含的小费,金额数字。例如 1.02
demoOptionalstringdata.demo自定义字段
notify_urlOptionalstringdata.notify_url支付完成后异步通知地址

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Parâmetros

ParameterTypeDescriçãoObrigatório
data.pay_methodstringoffline✓
data.sub_pay_methodstringWeChat Pay,Alipay,UnionPay QRcode,通过接口[获取sub pay method](/yabandpay/docs/v3-cn/payments/simplepay/subpaymethod) 获取。**如果为空(推荐),将由YabandPay来做支付方式判断。**—
data.order_idstring商户订单号✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1✓
data.tip_amountstring总金额中包含的小费,金额数字。例如 1.02—
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.demostring自定义字段—
data.auth_codestring微信支付或者支付宝+钱包的授权码✓
data.descriptionstring订单描述✓
data.notify_urlstring支付完成后异步通知地址—

Para pagamentos em lojas físicas, com suporte a WeChat Pay e Alipay+.

CampoTipoDescriçãoObrigatório
userStringConta de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.BarcodePaymentObrigatório
timeLongTimestampObrigatório
  • Parâmetros
CampoTipoDescriçãoObrigatório
pay_methodStringofflineObrigatório
sub_pay_methodStringWeChat 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_idStringID do pedido do estabelecimentoObrigatório
amountStringValor como cadeia numérica. Por exemplo, informe 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1.Obrigatório
tip_amountStringGorjeta incluída no valor total, como cadeia numérica; por exemplo, 1.02Opcional
currencyStringCódigo da moeda ISO 4217 currency code, for example EUR or CHFObrigatório
demoStringCampo personalizadoOpcional
auth_codeStringCódigo de autorização da carteira WeChat Pay ou Alipay+Obrigatório
descriptionStringDescrição do pedidoObrigatório
notify_urlStringURL de notificação assíncrona após o pagamentoOpcional

Exemplo de assinatura:

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

"amount=2.1&auth_code=134443133735495918&currency=EUR&demo=test&description=YabandPay test&method=v3.BarcodePayment&notify_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

  1. Se o cliente não precisar inserir uma senha, o resultado do pagamento será retornado de forma síncrona.
  1. 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.
  1. 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:
StatusCodeMessage
true200Success
false-1000Internal error
false-1007Identity code is invalid
false-4011Not support the payment method
false-4015This order has been closed
false-4028WeChat Pay is not available
false-4029Alipay is not available
false-4086Unknow identity code