Bizum is a mobile payment solution primarily used in Spain that allows users to send and receive money in real-time through their bank's mobile app. It operates as an instant peer-to-peer (P2P) transfer service, and merchants only need the consumers phone number to initiate transactions, making it a convenient alternative to traditional bank transfers.

Payment method properties

Make a Bizum payment

Bizum is available through our standardized REDIRECT and APP_NOTIFICATION flows. Enabling you to offer a seamless desktop or mobile handoff experience.

To create a Bizum payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Request

POST /v1/payment-charges

{
  "paymentMethod": "BIZUM",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "consumer": {
    "name": "John Smith",
    "country": "ES"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    },
    {
      "type": "APP_NOTIFICATION",
      "settings": {}
    }
  ]
}

Response

You'll receive our standard payment charge response (see potential responses in the API Reference) with the available authentication methods.

{
  "id": "charge_X0O78tadFHrZCbGhkycPk",
  "status": "AUTHENTICATION_PENDING",
  
  // ...
  
  "authenticationMethods": [
    {
      "type": "REDIRECT",
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      }
    },
     {
      "type": "APP_NOTIFICATION"
    }, 
  ]
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will finalize the payment process on the redirected page.

APP_NOTIFICATION

1. Ask your consumer for the required identifier needed to initiate the push notification, often a phone or bank account number.
2. Issue the following request to POST /v1/payment-charges/{paymentChargeId}/authorizations

{
  "authenticationResult": {
    "type": "APP_NOTIFICATION",
    "details": {
      "instrumentProviderIdentity": "124567"
    }
  }
}

3. The consumer will receive a push notification to complete the payment process.

Handling the payment result

REDIRECT

1. Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
2. After the consumer is redirected back to your site, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome. If the shopper closes the browser and doesn't return to your website, you can rely on webhooks to receive the payment result.

APP_NOTIFICATION

1. The payment charge will remain in the AUTHENTICATION_PENDING state until the consumer confirms the payment.
2. Check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for Bizum, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_5ChenWBwW8xARvJ3GccAx",
    "type": "PASSTHROUGH_WALLET"
}