Payment-method icon

Bizum for API-only

Add Bizum to an existing API-only integration.

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

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Setup steps Before you begin:

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

Adyen provides a logo for Bizum that you can use on your payment form. For more information, refer to Downloading logos.

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.

API response

You receive a response containing:

  • resultCode: Use this to present the result to your shopper.
  • pspReference: Our unique identifier for the transaction.

Show the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

You can receive the following resultCode values for Bizum:

resultCode Description Action to take
Authorised The shopper completed their payment, and it has been sent to the bank for processing. In most cases, this means that you will receive the funds. If you are using manual capture, you also need to capture the payment. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Pending or
Received		 The shopper has completed the payment but the final result is not yet known. Inform the shopper that you have received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

You also receive the outcome of the payment asynchronously in a webhook. If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. You can receive the following webhooks for Bizum:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.

Test and go live

To test Bizum payments:

  • Use telephoneNumber: 700 000 000.

  • Note that the payments amount value determines the outcome:

    Amount Outcome
    Less than 15 Payment is authorized
    From 15 to 50 Payment is refused
    From 50 to 1000 Payment is authorized
    More than 1000 Payment is refused

  • Check the status of Bizum test payments in your Customer Area > Transactions > Payments.

See also