Documentação/Referência da API

API REFERENCE

Pagamentos Mini Program

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

Pagamentos Mini Program

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

Request parameters10

Required fields first

小程序支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodAlipay
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 3
sub_pay_method_typeOptionalstringdata.sub_pay_method_type参考支持的钱包列表
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_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_methodstringonline✓
data.sub_pay_methodstringAlipay✓
data.sub_pay_method_typestring参考支持的钱包列表—
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓

Dica

Só é suportada a carteira Alipay China. As restantes carteiras Alipay+ não são suportadas. Para integrar o Mini Program Alipay+, consulte a documentação oficial do Alipay+ (https://miniprogram.alipay.com/docs-alipayconnect/miniprogram_alipayconnect/solutions/cn-cashier-payment).

ParâmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CreatePaymentsAlipayMiniPayObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringAlipayObrigatório
sub_pay_method_typeStringConsulte a lista de carteiras suportadasOpcional
order_idStringID do pedido do comercianteObrigatório
amountStringMontante em formato de cadeia numérica. Por exemplo, introduza 24.99 para € 24.99. Montante em CNY >=1; montante em EUR >=0.1.Obrigatório
currencyStringCódigo de moeda ISO 4217, como EUR ou CHFObrigatório
descriptionStringDescrição do pedidoObrigatório
demoStringCampo personalizadoOpcional
timeoutStringTempo de expiração em minutos (0-1440)Obrigatório
redirect_urlStringURL de redirecionamento após o pagamentoOpcional
notify_urlStringURL de notificação assíncrona após o pagamentoObrigatório

Signature example:

Parâmetros ordenados e concatenados numa cadeia de consulta no formato de URL

"amount=1&currency=EUR&description=YabandPay test&method=v3.CreatePaymentsAlipayMiniPay&notify_url=https://www.yabandpay.com/notify&order_id=2024519846516588484&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=Alipay&time=1546588959&timeout=0&user=YOUR_CASHIER_UID"

Assine a stringA utilizando secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CreatePaymentsAlipayMiniPay",
	"time": 1546588959,
	"data": {
		"description": "YabandPay test",
		"timeout": "0",
		"pay_method": "online",
		"sub_pay_method": "Alipay",
		"order_id": "YOUR_ORDER_ID",
		"amount": "1",
		"currency": "EUR",
		"notify_url": "https://www.yabandpay.com/notify",
		"redirect_url": "https://www.yabandpay.com"
	}
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "5902ea82-df87-bc30-3eef-c9cd1c64555c",
        "amount": "1",
        "currency": "EUR",
        "parameters": {
            "transaction_id": "2816660400948ddP1j0Et1lNHl2sOlC0bKn0"
        },
        "state": "processing"
    },
    "message": ""
}

Additional information:

Response result:
  1. Um pedido bem-sucedido devolve "status": true.

  2. Um pedido mal-sucedido devolve "status": false.

Recomendamos vivamente utilizar Query Order e Asynchronous Notifications para manter os estados dos pagamentos corretos e atualizados.

Carteiras suportadas pelo Alipay+:

As carteiras correspondentes a sub_pay_method_type suportam os seguintes cenários de pagamento:

sub_pay_method_typeAPPWAPWebMini Program
ALIPAY_CN✅❌✅✅
TRUEMONEY✅❌✅✅
ALIPAY_HK✅✅✅✅
TNG✅✅✅✅
GCASH✅✅✅✅
DANA✅✅✅✅
KAKAOPAY✅❌✅❌
RABBIT_LINE_PAY✅❌✅❌
BPI❌✅✅❌
BOOST✅✅✅❌
AKULAKU_PAYLATER✅✅✅❌
BILLEASE✅✅✅❌
TINABA✅✅✅❌
NAVERPAY❌✅✅❌
TOSSPAY✅❌✅✅
MPAY✅✅✅❌
KREDIVO_ID✅❌✅❌
KPLUS✅✅✅❌
HIPAY✅✅✅✅
Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method