Skip to main content

Bizum

Accept Bizum payments on your website or mobile app using the Hosted Payment Page or Bizum Component. No extra configuration is needed for the Hosted Payment Page.

The Bizum Component renders a Bizum button on your payment page. When customers select Bizum, an overlay appears where they enter their registered phone number to complete the payment.

:::caution Bizum Payment Status Monitoring MONEI actively monitors Bizum transaction status to ensure consistency between the payment gateway and processor, preventing discrepancies that could affect merchants or consumers. :::

Before you begin​

This page explains how to add Bizum to your payment page. To accept Bizum payments please contact our Support Team to configure Bizum.

Before you start, you need to make sure that you have Bizum enabled in MONEI Dashboard → Settings → Payment Methods.

To test your integration:

Integration​

1. Create a Payment Server-side​

Create a Payment on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

POST https://api.monei.com/v1/payments
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'

(Replace YOUR_API_KEY with your actual MONEI API key)

The following parameters are required:

  • amount positive integer - Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD)
  • currency string - Three-letter ISO currency code, in uppercase. Must be a supported currency.
  • orderId string - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
  • callbackUrl string - The URL to which a payment result should be sent asynchronously.

Check all available request parameters.

Included in the returned Payment object is a payment id, which is used on the client side to securely complete the payment process instead of passing the entire Payment object.

2. Add Bizum to your payment page Client-side​

Include monei.js on your checkout page by adding the script tag to the head of your HTML file.

checkout.html
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v3/monei.js"></script>
</head>

Add MONEI Bizum Component to your payment page. Create empty DOM node (container) with unique ID in your payment form.

checkout.html
<form
  action="https://secure.monei.com/payments/{{payment_id}}/confirm"
  method="post"
  id="payment-form"
>
  <div id="bizum_container">
    <!-- A MONEI Bizum Component will be inserted here. -->
  </div>
</form>

Initialize Bizum Component

client.js
// Create an instance of the Bizum component.
const bizum = monei.Bizum({
  paymentId: '{{payment_id}}',
  onSubmit(result) {
    // result.paymentMethod === 'bizum'
    moneiTokenHandler(result.token);
  },
  onError(error) {
    console.log(error);
  }
});

// Render an instance of the Bizum component into the `bizum_container` <div>.
bizum.render('#bizum_container');
note

Bizum Component is also available as a React, Vue, Angular, and Svelte component.

Check the MONEI JS Reference for more options.

3. Confirm the payment Client-side​

To complete the payment you need to confirm it using monei.js confirmPayment function.

You need to provide a paymentId (obtained in step 1) and paymentToken generated with Bizum Component. You can also provide additional parameters like customer.email. Check all available parameters.

client.js
// Confirm the payment
async function moneiTokenHandler(token) {
  try {
    const result = await monei.confirmPayment({
      paymentId: '{{payment_id}}',
      paymentToken: token
    });
    // At this moment you can show a customer the payment result
    // But you should always rely on the result passed to the callback endpoint
    // on your server to update the order status
    console.log(result);
  } catch (error) {
    console.error(error);
  }
}
note

As an alternative process you can submit generated paymentToken to your server and then confirm payment on the server-side.

4. Process Webhook Notification Server-side​

After the client-side interaction and any necessary background processing, MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the callbackUrl you provided in Step 1.

The request body contains the full Payment object in JSON format.

This webhook is the only reliable way to confirm the definitive payment outcome.

Crucially, you must:

  1. Verify the MONEI-Signature header included in the request. This confirms the webhook genuinely came from MONEI. See the Verify Signatures guide for implementation details.
  2. Return a 200 OK HTTP status code immediately upon receiving the webhook to acknowledge receipt. Any other status code tells MONEI the notification failed.

If MONEI doesn't receive a 200 OK, it will retry sending the webhook.

Once the signature is verified, inspect the status field in the Payment object (SUCCEEDED, FAILED, CANCELED, etc.) to determine whether to fulfill the order or handle the failure.

Before you go live​

Additional information​

Amount limits​

Online Bizum transactions have no maximum amount limit. If a transaction fails, it may be due to the issuing bank imposing its own limit or insufficient funds. Unlike peer-to-peer (P2P) limits, there is no monthly cap on online purchases.

Pre-authentications​

Bizum supports pre-authentications (transactionType: AUTH) to verify the Bizum number belongs to the account holder without holding funds. After successful authentication, you have up to 30 days to capture the payment. Both full and partial captures are supported. If insufficient funds are available at capture time, the transaction will not proceed. No additional SCA is required during capture.

Pre-authentications are available only if the customer's bank supports the RTP (Request to Pay) flow.

Refunds​

Bizum transactions can be refunded within 180 days. Refunds may fail if:

  • The customer has disconnected their Bizum account.
  • The customer has changed the link between their phone number and IBAN.
  • The issuing bank is experiencing internal issues with Bizum notifications.

Subscriptions​

You can use Bizum for subscriptions or recurring payments, similar to card-based subscriptions. Set Bizum as the payment method when creating a subscription through the MONEI API.

Key considerations:

  • Bank coverage is still being deployed, with 90%+ user coverage targeted. If the customer's bank does not support Bizum subscriptions, the subscription will not work. Confirm this directly with your customer.
  • The customer authorizes only the first payment. Subsequent payments are processed automatically via the MONEI subscriptions engine, or you can manage them manually using the recurring payments API.
  • Only one recurring payment per month can be made through Bizum, and the subscription amount cannot be changed after the first payment.

Payment Request​

You can send a payment request directly to the customer's phone. If the phone number is registered with Bizum, the customer receives a push notification to confirm the payment in their banking app. If not, they receive a payment link via WhatsApp. This feature works independently of the UI Component.

Example of a Bizum push notification:

Bizum Push Notification