Bizum for API-only

Accept Bizum payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Build your payment form for Bizum

Include Bizum as an available payment method in your payment form. You do not need to collect any information from the shopper in your payment form.

If you are using the /paymentMethods endpoint to show available payment methods to the shopper, specify these parameters:

• countryCode: ES
• amount.currency: EUR

API response

The response contains paymentMethod.type: bizum.

Make a payment

When a shopper chooses to pay with Bizum, you need to redirect them to the Bizum hosted page.

In your /payments request, specify:

• paymentMethod.type: bizum
• returnUrl: The URL the shopper is redirected to after they complete the payment. This URL can have a maximum of 1024 characters.
• reference: Your unique reference for the payment. Your reference must match the following regular expression: ^[a-zA-Z0-9]{4,125}$).

API response

The /payments response contains:

• action.url: Use this to redirect the shopper to the Bizum hosted page.
• action.data: Add this data when making POST call to action.url.

Handle the redirect

1. To complete the payment, make a POST request with the following elements:

   • Redirect the shopper to the action.url returned in the /payments response.
   • Use content type x-www-form-urlencoded to include the parameters from the data object as key-value pairs.
     Bizum requires the x-www-form-urlencoded content type.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.