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 parameters11

Required fields first

App支付

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支付完成后异步通知地址
os_typeRequiredstringdata.os_type安卓端传android 苹果端传ios
Optional parameters 3
sub_pay_method_typeOptionalstringdata.sub_pay_method_type参考支持的钱包列表
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址;IOS和Android注意:回调到APP处理的,需要applink或者deeplink做回调处理

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.notify_urlstring支付完成后异步通知地址✓
data.redirect_urlstring支付完成后跳转地址;IOS和Android注意:回调到APP处理的,需要applink或者deeplink做回调处理—
data.os_typestring安卓端传android 苹果端传ios✓
ParâmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CreatePaymentsAlipayAppPayObrigató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 numérico. Por exemplo, € 24.99 deve ser indicado como 24.99; montante em CNY >=1 e em euros >=0.1Obrigató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
notify_urlStringURL de notificação assíncrona após a conclusão do pagamentoObrigatório
redirect_urlStringURL de redirecionamento após a conclusão do pagamento. Em IOS e Android, utilize um applink ou deeplink para tratar os callbacks da APPOpcional
os_typeStringIndique android para Android e ios para AppleObrigató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.CreatePaymentsAlipayAppPay&notify_url=https://www.yabandpay.com/notify&order_id=202412654894165484&os_type=ios&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&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.CreatePaymentsAlipayAppPay",
    "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/redirect_url",
        "os_type": "ios"
    }
}

Response example:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "e5baf40b-08b2-4660-ed20-d632eeeceab3",
    "amount": "0.01",
    "currency": "EUR",
    "parameters": {
      "pay_url": "https://open-sea-global.alipayplus.com/api/open/v1/ac/cashier/self/codevalue/checkout.htm?codeValue=281666040097PyqF6IxZEzTURq7PhvTv3ken",
      "payments_data": "{\"displayPaymentAmount\":\"0.01\",\"displayPaymentCurrency\":\"EUR\",\"wallets\":[{\"enabled\":true,\"promoNames\":[\"{\\\"en_US\\\":\\\"test\\\",\\\"nl_NL\\\":\\\"test\\\"}\"],\"searchKeywords\":[\"dana wallet\"],\"walletName\":\"DANA\"}]}"
    },
    "state": "processing"
  },
  "message": ""
}

Additional information:

Se a sua APP utilizar um webview, redirecione diretamente para pay_url.

Se a sua APP tiver sido desenvolvida para IOS ou Android, transfira o SDK correspondente: Download.

Consulte a documentação oficial do AliPay+ para obter instruções de integração.

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