Documentação/Referência da API

API REFERENCE

Pagamentos na aplicação

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

Pagamentos na aplicação

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

Request parameters9

Required fields first

App支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodWeChat Pay
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支付完成后异步通知地址
sub_app_idRequiredstringdata.sub_app_idAPP的APPID
Optional parameters 1
demoOptionalstringdata.demo自定义字段

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_methodstringWeChat Pay✓
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.notify_urlstring支付完成后异步通知地址✓
data.sub_app_idstringAPP的APPID✓

Dica

Nota: forneça à YabandPay o Appid do seu Mini Program WeChat. Esta funcionalidade tem de ser ativada antes de ser utilizada.

ParâmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CreatePaymentsWechatAPPPayObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringWeChat PayObrigatório
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, por exemplo EUR ou CHFObrigatório
descriptionStringDescrição do pedidoObrigatório
demoStringCampo personalizadoOpcional
timeoutStringTempo de expiração em minutos (0-1440)Obrigatório
notify_urlStringURL de notificação assíncrona após o pagamentoObrigatório
sub_app_idStringAPPID da aplicaçãoObrigatório

Signature example:

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

"amount=0.1&currency=EUR&description=YabandPay test&method=v3.CreatePaymentsWechatAPPPay&notify_url=https://www.yabandpay.com/notify&order_id=202459846951635165&pay_method=online&sub_app_id=wxc72defa5cec6dfc7&sub_pay_method=WeChat Pay&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.CreatePaymentsWechatAPPPay",
	"time": 1546588959,
	"data": {
		"description": "YabandPay test",
		"timeout": "0",
		"pay_method": "online",
		"sub_pay_method": "WeChat Pay",
		"order_id": "YOUR_ORDER_ID",
		"amount": "0.1",
		"currency": "EUR",
		"notify_url": "https://www.yabandpay.com/notify",
		"sub_app_id": "wxc72defa5cec6dfc7"
	}
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "eaf6b81c-1a19-3ce5-d2d7-4002d6812c76",
        "amount": "0.10",
        "currency": "EUR",
        "parameters": {
            "appid": "wxc72defa5cec6dfc7",
            "partnerid": "299811131",
            "prepayid": "wx15164758052100530086b5391151892200",
            "package": "Sign=WXPay",
            "noncestr": "_YB_5d2c3dbe544a4",
            "timestamp": "1563180478",
            "sign": "YOUR_SIGNATURE"
        },
        "state": "processing"
    },
    "message": ""
}

Transmita este parâmetro à interface App correspondente para iniciar o WeChat Pay.

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.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method