Documentación/Referencia de 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.

Parámetros

ParameterTypeDescripciónObligatorio
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 es una solución de pago móvil muy utilizada en España que permite realizar transferencias instantáneas entre particulares y empresas mediante números de teléfono móvil. Para los comercios, Bizum ofrece una forma rápida, segura y sencilla de aceptar pagos en línea y en tiendas físicas. Puede integrarse directamente en el sitio web, la aplicación (APP) o el sistema de punto de venta (POS) de una empresa. Los clientes solo tienen que introducir su número de teléfono móvil o escanear un código QR para pagar. Las transacciones se liquidan en tiempo real y los clientes deben autorizar los pagos desde sus aplicaciones de banca móvil, lo que garantiza un alto nivel de seguridad y cumplimiento de la Directiva revisada sobre servicios de pago (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.


ParámetroTipoDescripciónObligatorio
userStringCuenta de cajero UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CreatePaymentsObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
pay_methodStringonlineObligatorio
sub_pay_methodStringBizumObligatorio
order_idStringID de pedido del comercioObligatorio
amountStringImporte numérico. Por ejemplo, € 24.99 debe indicarse como 24.99; importe en euros >=1Obligatorio
currencyStringEURObligatorio
descriptionStringDescripción del pedidoObligatorio
demoStringCampo personalizadoOpcional
timeoutStringTiempo de expiración en minutos (0-1440)Obligatorio
redirect_urlStringURL de redirección tras el pagoOpcional
notify_urlStringURL de notificación asíncrona tras el pagoObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de 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"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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

Información adicional:

Resultado de la respuesta:
  1. Una solicitud correcta devuelve "status": true.

  2. Una solicitud fallida devuelve "status": false.

Recomendamos encarecidamente utilizar tanto Consulta de pedido and Notificaciones asíncronas para mantener los estados de pago precisos y actualizados.

Códigos de respuesta:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method