API REFERENCE
Bizum
Bizum is a widely used mobile payment solution in Spain, designed to support instant transfers between users and businesses via mobile phone numbers. For merchants, Bizum offers a fast, secure, and easy-to-use way to accept payments online and in physical stores. It can be integrated directly into a company's website, application (APP), or point-of-sale system (POS system). Consumers simply enter their mobile phone number or scan a QR code to pay. Transactions settle in real time, and consumers must authorize payments through their mobile banking apps, ensuring a high level of security and compliance with the revised Payment Services Directive (PSD2). Most major Spanish banks support Bizum, which has more than 25 million users. It therefore offers merchants three core benefits: reaching more customers, reducing cart abandonment, and eliminating chargeback risk.
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | Cashier account UID | Required |
| sign | String | Signature | Required |
| method | String | v3.CreatePayments | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| pay_method | String | online | Required |
| sub_pay_method | String | Bizum | Required |
| order_id | String | Merchant order ID | Required |
| amount | String | Numeric amount. For example, € 24.99 must be written as 24.99; euro amount>=1 | Required |
| currency | String | EUR | Required |
| description | String | Order description | Required |
| demo | String | Custom field | Optional |
| timeout | String | Expiration time in minutes (0-1440) | Required |
| redirect_url | String | Redirect URL after payment | Optional |
| notify_url | String | Asynchronous notification URL after payment | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"amount=1¤cy=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments¬ify_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"
Sign stringA using secret_key
The resulting signature is:
"YOUR_SIGNATURE"
Request example:
{
"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"
}
}
Response example:
{
"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": ""
}
Additional information:
Response result:
-
A successful request returns "status": true.
-
A failed request returns "status": false.
We strongly recommend using both Query Order and Asynchronous Notifications to keep payment statuses accurate and up to date.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -3001 | Required field is missing |
| false | -403 | The signature Error |
| false | -4011 | Not support the payment method |
