Documentation/Référence API

API REFERENCE

CardCheck

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

CardCheck

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

Request parameters10

Required fields first

CardCheck

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCardCheck
operationRequiredstringdata.operation3
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 3
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
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_methodstringCardCheck✓
data.operationstring3✓
data.order_idstring商户的订单ID✓
data.descriptionstring订单描述✓
data.form_typestring返回的url类型,默认01。 01.completed, 02.iframe—
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Initiez une autorisation d’un montant de 0 pour permettre au titulaire de la carte de valider le numéro fourni. Le titulaire doit fournir des informations valides pour terminer la vérification.

La vérification peut être effectuée sur la page hébergée fournie par YabandPay. Les marchands peuvent traiter les requêtes en toute sécurité en hébergeant les données sensibles PCI DSS sur le système YabandPay.

Conseil

Récupérez le résultat de vérification via Requête de commande.

ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CardCheckObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | pay_method | String | online | Obligatoire | | sub_pay_method | String | CardCheck | Obligatoire | | operation | String |3| Obligatoire| | order_id | String | ID de commande du marchand | Obligatoire | | description | String | Description de la commande | Obligatoire | | form_type | String | Type of returned url; defaults to 01. 01.completed, 02.iframe | Facultatif | | 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 | | request_id | String | ID de requête unique ; une combinaison de chiffres et de lettres d’au moins 24 caractères est recommandée | Obligatoire |

Exemple de signature:

Paramètres triés et concaténés sous forme de chaîne de requête au format URL

"description=cardcheck test&form_type=01&method=v3.CardCheck&notify_url=https://www.yabandpay.com/notify&operation=3&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=CardCheck&time=1720680417&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.CardCheck",
    "time": 1720680417,
    "data": {
        "description": "cardcheck test",
        "form_type": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "CardCheck",
        "operation": "3",
        "order_id": "YOUR_ORDER_ID",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Exemple de réponse:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "0.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
        "state": "processing"
    },
    "message": "",
    "response_id": "202407111544200649155078"
}

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.

Redirigez l’utilisateur vers url. Après avoir saisi ses coordonnées de carte sur cette page url et terminé le paiement, il est redirigé de manière synchrone vers redirect_url. Nous recommandons vivement d’utiliser à la fois Requête de commande and Asynchronous Notifications to synchronize and update the payment status and keep payment information accurate in real time. a) Si le statut de commande state est paid, le paiement a réussi ;

Codes de réponse:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID