Documentation/Référence API

API REFERENCE

Paiements par jeton

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

Paiements par jeton

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

Request parameters12

Required fields first

Token支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodToken
operationRequiredstringdata.operation11.Token for sales 12.Token for authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
payment_token_objectRequiredstringdata.payment_token_object支付Token
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 1
demoOptionalstringdata.demo自定义字段

请求参数

3ds_initiateRequiredstringdata.3ds_initiate01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);

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_methodstringToken✓
data.operationstring11.Token for sales 12.Token for authorisation;✓
data.order_idinteger商户的订单ID✓
data.sca_exemptionstringLowValue✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.payment_token_objectstring支付Token✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.3ds_initiatestring01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);✓

S’applique à l’initiation de paiements par Token avec une carte de crédit

Une fois que le payeur a effectué une transaction standard par carte de crédit sur la page de paiement hébergée de YabandPay et donné son consentement, YabandPay convertit les données sensibles du titulaire en une chaîne numérique aléatoire (un Token) afin de supprimer les informations permettant de l’identifier. Le Token peut être utilisé pour les paiements suivants :

  1. Les utilisateurs peuvent payer en un clic sur la page de paiement, sans saisir les coordonnées de leur carte.
  2. Les marchands peuvent utiliser ce Token pour les paiements récurrents, les abonnements et des usages similaires.

[!TIP|style:flat] Workflow

  1. Activez les paiements par Token. Contactez votre chargé de compte pour activer cette fonctionnalité.
  1. Obtenez le consentement de l’utilisateur. Lors de l’activation des paiements express (paiements par Token), vous devez informer clairement les consommateurs et obtenir leur consentement afin d’éviter tout litige.
  1. Obtenez un Token. Commencez par initier une transaction standard par carte de crédit. YabandPay renvoie a payment url. After the user completes payment through that url and gives consent, YabandPay renvoie the Token in an asynchronous notification using the payment_token_object parameter.
  1. Initiez un paiement par Token. Incluez le Token dans la payment_token_object variable. Si la validation du Token réussit, YabandPay traite le paiement. Dans le cas contraire, YabandPay renvoie une erreur. Dans ce cas, nous recommandons d’initier une nouvelle transaction standard par carte de crédit pour obtenir un Token, puis de relancer le paiement.
ParamètreTypeDescriptionObligatoire
userStringCashier account UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreateCardPaymentsObligatoire
timeLongTimestampObligatoire
  • Parameters
ParamètreTypeDescriptionObligatoire
pay_methodStringonlineObligatoire
sub_pay_methodStringTokenObligatoire
operationString11.Token for sales 12.Token for authorisation;Obligatoire
order_idStringMerchant order IDObligatoire
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Obligatoire
sca_exemptionStringLowValue3ds_initiate=03 Required
amountStringAmount as a numeric string. For example, enter 24.99 for € 24.99.Obligatoire
currencyStringISO 4217 currency code, for example EUR or CHFObligatoire
payment_token_objectStringPayment TokenObligatoire
descriptionStringOrder descriptionObligatoire
demoStringCustom fieldFacultatif
timeoutStringExpiration time in minutes (0-1440)Obligatoire
notify_urlStringAsynchronous notification URL after paymentObligatoire
request_idStringUnique request ID; a combination of digits and letters at least 24 characters is recommendedObligatoire

Signature example:

Sorted parameters concatenated into a URL-style query string

"3ds_initiate=01&amount=1&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875543&pay_method=online&payment_token_object=VnXaRabcsedfsSlPFZXavcsdfasdEFDd&request_id=hjf5lv32i40lh7oh86j6az98tnscwv37&sub_pay_method=Token&time=1725875543&timeout=0&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

Le champ resulting signature is:

"YOUR_SIGNATURE"

Exemple de requête:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1725875543,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Token",
        "operation": "11",
        "order_id": 1725875543,
        "amount": "1",
        "currency": "EUR",
        "payment_token_object": "VnXaRabcsedfsSlPFZXavcsdfasdEFDd",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "hjf5lv32i40lh7oh86j6az98tnscwv37"
    }
}

Exemple de réponse:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "109bb0e9-e1fb-49cb-c537-ec944f33c388",
        "amount": "1.00",
        "currency": "EUR",
        "state": "paid"
    },
    "message": "",
    "response_id": "202409091752241912726578"
}

Informations complémentaires:

MIT & CIT :

MIT = Merchant Initiated subsequent transactions. Token payments initiated by the merchant.

CIT = Cardholder Initiated Subsequent transactions. Token payments involving the customer. When activating payments, specify whether you need MIT or CIT so the appropriate mode can be configured.

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

  2. Si l’appel échoue, "status": false est renvoyé. If you receive Invalid Token, we recommend calling HPP Token again to obtain a new Token.

Le champ API returns the payment status synchronously. Nous recommandons vivement d’utiliser à la fois Order Query and Asynchronous Notifications afin de synchroniser et mettre à jour le statut du paiement et de maintenir les informations exactes en temps réel. a) If the order status state is paid, payment succeeded; b) if the order status state is authorized, authorization succeeded. To capture funds after successful authorization, call the authorization capture API.

3DS low-value exemption:

Les transactions respectant les limites suivantes peuvent être considérées comme des transactions de faible montant. Si le montant de la commande est inférieur ou égal au plafond applicable ci-dessous, le code de transaction 02 (low-value exemption) peut être utilisé sous réserve d’approbation.

#CurrencyAmount
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4119Invalid Token
false-4120No operational permissions