Documentation/Référence API

API REFERENCE

Bizum

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

Bizum

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

Request parameters9

Required fields first

介绍

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodBizum
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1
currencyRequiredstringdata.currencyEUR
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 2
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_methodstringBizum✓
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1✓
data.currencystringEUR✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓

Bizum est une solution de paiement mobile très répandue en Espagne, conçue pour permettre les virements instantanés entre particuliers et entreprises à l’aide de numéros de téléphone mobile. Pour les marchands, Bizum offre un moyen rapide, sécurisé et simple d’accepter des paiements en ligne et en magasin. Il peut être intégré directement au site Web, à l’application (APP) ou au système de point de vente (POS) de l’entreprise. Les consommateurs saisissent simplement leur numéro de téléphone mobile ou scannent un code QR pour payer. Les transactions sont réglées en temps réel et les consommateurs doivent autoriser les paiements dans leur application bancaire mobile, ce qui garantit un niveau élevé de sécurité et de conformité à la directive révisée sur les services de paiement (PSD2). La plupart des grandes banques espagnoles prennent en charge Bizum, qui compte plus de 25 millions d’utilisateurs. Il offre donc aux marchands trois avantages clés : toucher davantage de clients, réduire les abandons de panier et éliminer le risque de rétrofacturation.


ParamètreTypeDescriptionObligatoire
userStringCompte caissier UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | pay_method | String | online | Obligatoire | | sub_pay_method | String | Bizum | Obligatoire | | order_id | String | ID de commande du marchand | Obligatoire | | amount | String | Montant numérique. Par exemple, € 24.99 doit être indiqué comme 24.99 ; le montant minimum en euros est >=1 | Obligatoire | | currency | String | EUR | Obligatoire | | description | String | Description de la commande | Obligatoire | | demo | String | Champ personnalisé | Facultatif | | timeout | String | Délai 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 dans une chaîne de requête au format URL

"amount=1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&order_id=20240726785412369&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=Bizum&time=1646388458&timeout=0&user=YOUR_CASHIER_UID"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.CreatePayments",
  "time": 1646388458,
  "data": {
    "description": "YabandPay test",
    "timeout":"0",
    "pay_method": "online",
    "sub_pay_method": "Bizum",
    "order_id": "YOUR_ORDER_ID",
    "amount": "1",
    "currency": "EUR",
    "redirect_url": "https://www.yabandpay.com",
    "notify_url": "https://www.yabandpay.com/notify",
    "demo": "test"
  }
}

Exemple de réponse :

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "6ff1026e-e4e9-f6c9-d275-3323594064e0",
    "amount": "1.00",
    "currency": "EUR",
    "url": "https://pay.yabandpay.com/pay_method/Yml6dW0=/NmZmMTAyNmUtZTRlOS1mNmM5LWQyNzUtMzMyMzU5NDA2NGUw",
    "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 Consultation de commande et Notifications asynchrones afin de maintenir des statuts de paiement exacts et à jour.

Codes de réponse :
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method