Documentação/Referência da 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

ParameterTypeDescriçãoObrigatório
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 é uma solução de pagamento móvel amplamente utilizada em Espanha, concebida para permitir transferências instantâneas entre utilizadores e empresas através de números de telemóvel. Para os comerciantes, Bizum oferece uma forma rápida, segura e simples de aceitar pagamentos online e em lojas físicas. Pode ser integrado diretamente no site, na aplicação (APP) ou no sistema de ponto de venda (sistema POS) de uma empresa. Para pagar, os consumidores só têm de introduzir o número de telemóvel ou ler um código QR. As transações são liquidadas em tempo real e os consumidores têm de autorizar os pagamentos através das aplicações de banca móvel, o que assegura um elevado nível de segurança e conformidade com a Diretiva dos Serviços de Pagamento revista (PSD2). A maioria dos principais bancos espanhóis suporta Bizum, que conta com mais de 25 milhões de utilizadores. Assim, oferece aos comerciantes três vantagens principais: alcançar mais clientes, reduzir o abandono do carrinho e eliminar o risco de estorno.


ParâmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CreatePaymentsObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringBizumObrigatório
order_idStringID do pedido do comercianteObrigatório
amountStringMontante numérico. Por exemplo, € 24.99 deve ser indicado como 24.99; montante em euros >=1Obrigatório
currencyStringEURObrigatório
descriptionStringDescrição do pedidoObrigatório
demoStringCampo personalizadoOpcional
timeoutStringTempo de expiração em minutos (0-1440)Obrigatório
redirect_urlStringURL de redirecionamento após o pagamentoOpcional
notify_urlStringURL de notificação assíncrona após o pagamentoObrigatório

Signature example:

Parâmetros ordenados e concatenados numa cadeia de consulta no 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"

Assine a stringA utilizando secret_key

A assinatura resultante é:

"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:
  1. Um pedido bem-sucedido devolve "status": true.

  2. Um pedido mal-sucedido devolve "status": false.

Recomendamos vivamente utilizar Query Order e Asynchronous Notifications para manter os estados dos pagamentos corretos e atualizados.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method