Skip to main content

Creating Payment Flows in the Builder/Studio with the Payment Block

  • Updated

  1. Introduction: Speeding Up Your Sales

  2. Creating and Configuring the Payment Block

  3. Block Exit Conditions

 

Important: This product is in Alpha and is not available for general use. Access is granted upon request via KAM, AM, or CSM, with validation from the Payments team.

Available Channel: WhatsApp

 

Introduction: Speeding Up Your Sales

The Blip Payment Block is the platform's native solution for efficiently requesting payments. It allows you to configure payment methods (PIX, Boleto, Link) and detail the products sold, all within your Blip flow.

What does your customer receive? Your customer receives a complete and easy-to-understand payment message on WhatsApp, containing:

  • Product or service name and description.

  • Exact order value.

  • Chosen payment method.

  • A personalized message.

 

Creating and Configuring the Payment Block

  • Configuring the block is a structured process in three main steps within the Builder/Studio:

1. Add the Payment Block

  • Access your bot's Studio (the flow editor).

  • Click New block and select the Payment option.

  • The block will be inserted into the flow and must be connected at a logical point in the journey.

 

2. Configure the Payment Method In this tab, you define the payment options offered to the customer.

  • Payment method: choose between PIX Copy and Paste, Boleto, or Payment Link.

If PIX is selected, specific fields for this format (key type and value, plus the Copy and Paste code) will be displayed.

  • Business name: the name displayed to the customer (e.g., Blip Payments).

  • PIX key type: select CPF, CNPJ, Email, Phone, or Random key.

  • PIX key value: enter the corresponding data (Note: CPF or CNPJ must be valid).

  • PIX Copy and Paste code: enter the code generated by your bank.

 

Currently, you can configure these three payment methods and work with either dynamic or fixed values, depending on your business rules.

For dynamic values: these refer to a specific order, usually processed through an acquirer API request. The request actions and script executions must be performed before the payment block is added, and the corresponding value must be referenced in the appropriate field using a variable. For example, instead of entering the Pix "copy and paste" code directly on the configuration screen, you would enter the value {{pixRequest@pixCode}}. This indicates that the code is stored in this variable, which was generated in the previous block.

You can also add a second payment method if you wish to offer more than one option to the customer.

When adding Boleto, you enter the barcode/payment code or the variable; for the Payment Link, enter the https link or the variable.

 

3. Configure product details

Access the Configuration tab and complete:

  • Product type: choose whether it is Digital or Physical.

  • Charge number: can be a fixed value (e.g., 123456) or a variable that pulls the product ID (e.g., {{selectedProduct@retailer_id}}). It must be a value with a maximum of 35 characters, containing only letters, numbers, and dashes.

  • Product specifications: provide the JSON Array in the format below:

JSON

[
  {
    "retailer_id": "123456",
    "name": "Item name",
    "amount": {
      "value": 1000,
      "offset": 100
    },
    "quantity": 1
  }
]

Within the field related to the product, it must return exactly in this format so that the payment block interprets the data correctly. To generate this JSON, a script can be used (executed in the block prior to the payment block) and the script's output variable should be provided, or the JSON Array can be entered directly into the field. Generally, the script path is used, especially when the selection of products and prices is dynamic. It is permitted to provide more than one item in this Array, as long as the JSON formatting for each item is respected.

  • Main text: message displayed alongside the payment, for example: “Finalize your order! Complete the payment via Pix copy and paste using your bank's app.”

  • Footer (optional): enter additional text, usually a short guidance or alert text such as: “Payment expires in 30 minutes,” or “Secure payment.”

 

Block Exit Conditions

Upon reaching this block in the flow, your customer will instantly receive the payment message with all the configured information, provided everything is set up correctly. The payment block does not have the option to wait for input; therefore, when passing through this block, your customer will be automatically directed to the next block according to your exit conditions. In the exit conditions, it is possible to define which block the customer will be directed to if there is an error and if there is success.

It may happen that some configuration is not as expected by WhatsApp, and when this occurs, the message will not be delivered to the user. By defining the exit condition for the error case, it will be possible to identify and handle the situation according to your business rules. When all configurations are correct and it is successfully directed, you can handle the next block according to your business rules. It is common for the next block to be one that confirms the payment according to the rules of your payment method API.

 

For more information, check out the discussion on this topic in our community or watch the videos on our channel. 😃

Related articles