Documentation/Référence API

API REFERENCE

Paiements via Mini Program

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

Paiements via 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.

Paramètres

ParameterTypeDescriptionObligatoire
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支付完成后异步通知地址✓

Conseil

Seul le portefeuille Alipay Chine est pris en charge. Les autres portefeuilles Alipay+ ne le sont pas. Pour intégrer Alipay+ Mini Program, consultez la documentation officielle d’Alipay+ (https://miniprogram.alipay.com/docs-alipayconnect/miniprogram_alipayconnect/solutions/cn-cashier-payment).

ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsAlipayMiniPayObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | pay_method | String | online | Obligatoire | | sub_pay_method | String | Alipay | Obligatoire | | sub_pay_method_type | String | Voir la liste des portefeuilles pris en charge | Facultatif | | order_id | String | ID de commande du marchand | Obligatoire | | amount | String | Montant au format chaîne numérique. Par exemple, saisissez 24.99 for € 24.99. montant en CNY ≥1; montant en EUR ≥0.1. | Obligatoire | | currency | String | ISO 4217 currency code, such as EUR or CHF | Obligatoire | | description | String | Description de la commande | Obligatoire | | demo | String | Champ personnalisé | Facultatif | | timeout | String | Durée d’expiration en minutes (0-1440) | Obligatoire | | redirect_url | String | URL de redirection après le paiement | Facultatif | | notify_url | String | URL de notification asynchrone après le paiement | Obligatoire |

Exemple de signature:

Paramètres triés et concaténés sous forme de chaîne de requête au format 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"

Signez la chaîne A à l’aide de secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête:

{
	"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"
	}
}

Exemple de réponse:

{
    "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": ""
}

Informations complémentaires:

Résultat de la réponse:
  1. Une requête réussie renvoie "status": true.

  2. Une requête échouée renvoie "status": false.

Nous recommandons vivement d’utiliser à la fois Consulter la commande and Asynchronous Notifications afin de maintenir les statuts de paiement exacts et à jour.

Portefeuilles pris en charge par Alipay+ :

Les portefeuilles correspondant à sub_pay_method_type prennent en charge les scénarios de paiement suivants :

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✅✅✅✅
Codes de réponse:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method