With Belvo's Open Finance Payment Initiation (OFPI), you can collect payments from your customers and optimize their payment experience. In this guide, we’ll show you:

• the general flow of data
• how to create a payment intent to collect payments
• track the status of your payment requests

Data flow overview

As you can see in the diagram below, the data flow for creating a payment using Pix via Open Finance involves:

1. Creating a payment intent (containing the required information for the payment to be processed in the Open Finance Network).
2. Listening for the OBJECT_CREATED webhook from the transactions resource.
3. Getting the transaction details.

Create a Payment Intent

The Payment Intent contains all the information necessary to register and process the payment in the Open Finance Network. To reduce friction for your customer, we recommend that you create your payment screen so that you can send all the information in just one POST call.

To create a Payment Intent, check out the recipe below which guides you through all the required parameters:

Once you successfully create a Payment Intent, you will need to use the URL in the payment_method_information.open_finance.redirect_url parameter to redirect your user to their financial institution to confirm the payment. After confirming the payment, your user is redirected back to the callback_url you provided in the Payment Intent request.

For details regarding the response from the Payment Intent request, please see our dedicated Payment Intent (OFPI) Model and States article.

Payment Intents, Charges, and Transactions

For each payment, Belvo generates a Charge object within the Payment Intent response body. Once a Charge is processed successfully, Belvo generates a Transaction associated with that Charge.

Payment statuses and notifications

Once you create an immediate payment, you will receive webhook updates for the associated Payment Intent, Charge, and Transaction.

Below you can see an example of an immediate payment and the associated statuses the payment will go through. You will receive STATUS_UPDATE webhook notifications for each status that is marked with a red dot (🔴).

When you receive the OBJECT_CREATED Transaction webhook event, this indicates that the given scheduled payment was settled.

Listen for payment status updates

Once you create the Payment Intent, Belvo will provide you updates regarding the payment via webhooks. As you can see in the image in the Data flow overview section, you will receive the following webhooks during the payment process:

Get details for successful transactions.

The OBJECT_CREATED webhook from the Transactions resource that indicates that the payment succeeded and funds were transferred from one account to another. This means that every time money has been successfully transferred to your account, you’ll receive the following notification:

{
  "webhook_id": "3b9a69f7-0f0a-455b-832d-49ad6fd4905c",
  "webhook_type": "TRANSACTIONS",
  "webhook_code": "OBJECT_CREATED",
  "object_id": "d2e40773-19f6-48d1-93c3-3590ec0c74df",
  "data": {}, //For OBJECT_CREATED webhooks, the data field returns an empty object.
}

You can get the details about the transaction by making a GET details call using the object_id of the transaction (which you receive in the webhook event).

curl --request GET \
     --url https://api.belvo.com/payments/br/transactions/{id}/ \
     --header 'accept: application/json'

You will receive the following information regarding the transaction:

{
  "id": "fd0f3303-cafb-47ea-9753-21155cb144ab",
  "created_at": "2020-04-23T21:30:20.336854+00:00",
  "created_by": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
  "amount": "500",
  "currency": "BRA",
  "description": "Awesome training Sneaker",
  "transaction_type": "INFLOW",
  "beneficiary": "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc",
  "payer": {},
  "payment_intent": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
  "customer": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

👍

And that's it! By following this guide you can make payments using Belvo's Pix via Open Finance product.