Pular para o conteúdo

Belvo API Docs (1.222.0)

Introduction

Reach new audiences and convert more users by easily and safely connecting to their financial data, understanding their behavior and enabling instant payments with open finance. Through our API, you can access:

Available Information and Payment Methods

Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way.

Through our API, you can access:

  • Banking Information in Brazil
  • Employment Information in Brazil
  • Employment Information in Mexico
  • Fiscal Information in Mexico
  • Fiscal Information in Chile

You can also use our API to make payments in:

  • Brazil
  • Mexico

Data Dictionaries

If you woud like the response documentation in Excel or CSV form, please download them from our public GitHub Reposiitory: Belvo Open Finance Data Dictionaries.

Our EXCEL and CSV files are additionally localized into Spanish and Portuguese (Brazil).

Environments

We currently offer two environments: sandbox and production.

Sandbox

Available for:

  • 🟢 Aggregation and Enrichment
  • ⚪️ Payment Initiation

Use our Sandbox environment to build your integration. We offer dummy data that mimics that of real-world use cases, which means you can test out all the endpoints, use the widget, and implement webhooks - just as you would with real-world data!

All you need to get started with the Sandbox environment is to get your API keys. We really recommend that you start creating your integration in this environment.

Production

Available for:

  • 🟢 Aggregation and Enrichment
  • 🟢 Payment Initiation

After you have tested your integration in the Sandbox environment and are ready to go live, you'll need to request access to our Production environment. After you request access, our Sales Team will get in contact with you to schedule a meeting just to ensure your needs are met, and then you'll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally. To prepare for the certification meeting, just follow our Integration checklist.

Once your integration is certified, all you'll need to do is:

  • Request Production API keys (and change your Sandbox API keys in the code to these new ones).
  • Change the base URL that you make requests to from sandbox.belvo.com to api.belvo.com.
  • If you're using webhooks, make sure to set a Production URL for your webhooks.

Response codes

We use the following HTTP status code in the response depending on the success or failure:

Status CodeDescription
200✅ Success - The content is available in the response body.
201✅ Success - The content was created successfully on Belvo.
204✅ Success - No content to return.
400❌ Bad Request Error - Request returned an error, detail in the content.
401❌ Unauthorized - The Belvo credentials provided are not valid.
404❌ Not Found - The resource you try to access cannot be found.
405❌ Method Not Allowed - The HTTP method you are using is not accepted for this resource.
408❌ Request Timeout - The request timed out and was terminated by the server.
428❌ MFA Token Required - MFA token was required by the institution to connect.
500❌ Internal Server Error - The detail of the error is available in the response body.

Error handling

Belvo API errors are returned in JSON format. For example, an error might look like this:

[
    {
      "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
      "message": "This field is required.",
      "code": "required",
      "field": "link"
    }
]

Typically, an error response will have the following parameters:

  • request_id: a unique ID for the request, you should share it with the Belvo support team for investigations.
  • message: human-readable description of the error.
  • code: a unique code for the error. Check the table below to see how to handle each error code.
  • field (optional): The specific field in the request body that has an issue.

Request identifier

When you need help with a specific error, include the request identifier (request_id) in your message to the Belvo support team. This will speed up investigations and get you back up and running in no time at all.

Error codes and troubleshooting

For a full list of errors and how to troubleshoot them, please see our dedicated Error Handling article.

Retry policy

50x errors

Implement an automated exponential backoff of up to five retries. We recommend using a base interval of three seconds with a factor of two. For example, the first retry should be after three seconds, the second retry after six seconds (2 * 3), the third retry after 12 seconds (2 * 6), the fourth retry after 24 seconds (2 * 12), and the fifth retry after 48 seconds (2 * 24).

40x errors

You should not retry making requests if you receive a 40x response, as this is a client error.

The only exception is the “Too Many Sessions” error, as it means that your end-user is accessing the account from another browser at the same time. In this case, please implement the same retry policy as with 50x errors.

Deprecated fields

In our schema, you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.

OpenAPI: required and nullable fields

In our API specification, you'll see that some response parameters will have a required annotation. According to the OpenAPI specification, when a response parameter is marked as required, this means that the response key must be returned. However, the value of that response parameter can be null.

📘 Info

In short, any response parameter marked as required will be returned by our API, but the value can be set to null.

Baixar o arquivo de descrição OpenAPI
BelvoOpenApiSpec.json
BelvoOpenApiSpec.yaml
Visão Geral
URL

https://developers.belvo.com

Need help?

support@belvo.com

Idiomas
Servidores
Sandbox

https://sandbox.belvo.com/

Institutions

An institution is an entity that Belvo can access information from. It can be a:

  • bank institution, such as Nubank Brazil.
  • fiscal institution, such as the Servicio de Administración Tributaria (SAT) in Mexico.
  • employment institutions, such as Instituto Mexicano del Seguro Social (IMSS) in Mexico or Instituto Nacional do Seguro Social (INSS) in Brazil.
Operações

Widget Access Token

Operações

Consents

A consent is a permission given by the end user to access their financial data in the Open Finance Network in Brazil.

Operações

Owners

An owner represents the person who has access to a Link and is the owner of all the accounts inside the Link.

You can use this endpoint in order to get useful information about your client, such as:

  • their full name
  • key contact information
  • information about the ID document they used when opening the account
Operações

Accounts

An account is the representation of a bank account inside a financial institution. A user can have one or more accounts in an institution.

For example, one user (or link) can have a checking account, several credit cards, and a loan account.

Querying for a user's account information is useful as you can get information regarding:

  • what types of accounts the user has.
  • the balance for each account (savings, checking, credit card, loan, and so on).
  • detailed information regarding their credit card spending.
  • the current situation of any loans they may have.
Operações

Balances

A balance is the amount of money available in a given bank account (checking or savings) at a given time.

Operações

Transactions

A transaction contains the detailed information of each movement inside an account. For example, a purchase at a store or a restaurant.

Operações

Bills

A bill refers to the credit card bill a user receives for a given account.

Operações

Investments Brazil

Operações

Investment Transactions Brazil

Operações

Employments Brazil

Our employments resource for Brazil lets you get a comprehensive view of your user's current employment history and salary information.

For each user, we return the:

  • work history (including occupations and employer data)
  • historical and current salary information (per employer)

At the moment, the employments resource is available for:

  • 🇧🇷 Brazil (INSS)
Operações

Employment Records Mexico

Our employment records resource for Mexico lets you get a comprehensive view of your user’s current social security contributions and employment history.

With Belvo's employment records resource for Mexico, you can access information about your user's current social security contributions and employment history. For the each user, we return the:

  • personal data
  • work history
  • historical and current daily base salary
  • and more!

At the moment, the employment records resource is available for:

  • 🇲🇽 Mexico (IMSS)
  • 🇲🇽 Mexico (ISSSTE)
Operações

Current Employments Mexico

The Current Employments resource provides real-time access to the current employment status of individuals in Mexico. This resource offers detailed information about whether an individual is currently employed or unemployed, along with their active employment records.

Operações

Invoices

Operações

Get an invoice's details

Requisição

Get the details of a specific invoice.

This resource may return deprecated fields. Please check the response documentation for more information.

Segurança
basicAuth
Caminho
idstring(uuid)obrigatório

The invoice.id you want to get detailed information about.

Consulta
omitstring

Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.belvo.com/api/invoices/{id}/?omit=string&fields=string'

Respostas

Ok

Corpoapplication/json
idstring(uuid)

Belvo's unique identifier for the current item.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

The link.id the data belongs to.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
collected_atstring(date-time)obrigatório

The ISO-8601 timestamp when the data point was collected.

Exemplo: "2022-02-09T08:45:50.406032Z"
created_atstring(date-time)

The ISO-8601 timestamp of when the data point was created in Belvo's database.

Exemplo: "2022-02-09T08:45:50.406032Z"
invoice_identificationstring or nullobrigatório

The fiscal institution's unique ID for the invoice.

Exemplo: "A1A1A1A1-2B2B-3C33-D44D-555555E55EE"
invoice_datestring or nullobrigatório

The date of the invoice, in YYYY-MM-DD format.

Exemplo: "2019-12-01"
statusstring or nullobrigatório

The status of the invoice. Can be either Vigente (valid) or Cancelado (cancelled).

Exemplo: "Vigente"
invoice_typestring or nullobrigatório

The fiscal institution's classification of the invoice.

For Mexico's SAT, we return one of the following values:

  • Egreso
  • Ingreso
  • Nómina
  • Pago
  • Traslado
Enum"Egreso""Ingreso""Nómina""Pago""Traslado"
Exemplo: "Ingreso"
typestring or nullobrigatório

The direction of the invoice (from the perspective of the Link owner).

  • OUTFLOW indicates a sent invoice.
  • INFLOW indicates a received invoice.
Enum"OUTFLOW""INFLOW"null
Exemplo: "INFLOW"
tax_detailsobject

General information about the taxes of the invoice.

sender_idstring or nullobrigatório

The fiscal ID of the invoice sender

Exemplo: "AAA111111AA11"
sender_fiscal_regimestring or null

The tax regime of the sender, as defined by the legal entity in the country.

Exemplo: "601"
sender_namestring or nullobrigatório

The name of the invoice sender.

Exemplo: "ACME CORP"
sender_tax_fraud_statusstring or null

Indicates whether or not the sender is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.

Possible statuses are:

  • INVESTIGATING
    The fiscal institution has identified irregularities and open an investigation regarding the taxpayer.
  • DISMISSED
    The fiscal institution has investigated the taxpayer and declared them innocent.
  • CONFIRMED
    The fiscal institution has confirmed that the taxpayer is guilty.
  • OVERTURNED
    The fiscal institution has reassessed a previously confirmed taxpayer and, based on new evidence, has taken the taxpayer off the tax fraud list.
  • NO_TAX_FRAUD_STATUS
    The receiver or sender is not found in the list (in other words, they are complying with the fiscal institution's regulations).
Exemplo: "NO_TAX_FRAUD_STATUS"
receiver_idstring or nullobrigatório

The fiscal ID of the invoice receiver.

Exemplo: "BBB222222BB22"
receiver_postal_codestring

The postal code of the receiver.

Exemplo: "11560"
receiver_fiscal_regimestring or null

The tax regime of the receiver, as defined by the legal entity in the country.

Exemplo: "601"
receiver_namestring or nullobrigatório

The name of the invoice receiver.

Exemplo: "BELVO CORP"
receiver_tax_fraud_statusstring or null

Indicates whether or not the receiver is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.

Possible statuses are:

  • INVESTIGATING
    The fiscal institution has identified irregularities and open an investigation regarding the taxpayer.
  • DISMISSED
    The fiscal institution has investigated the taxpayer and declared them innocent.
  • CONFIRMED
    The fiscal institution has confirmed that the taxpayer is guilty.
  • OVERTURNED
    The fiscal institution has reassessed a previously confirmed taxpayer and, based on new evidence, has taken the taxpayer off the tax fraud list.
  • NO_TAX_FRAUD_STATUS
    The receiver or sender is not found in the list (in other words, they are complying with the fiscal institution's regulations).
Exemplo: "NO_TAX_FRAUD_STATUS"
cancelation_statusstring or nullobrigatório

If the invoice is cancelled, this field indicates the status of the cancellation.

cancelation_update_datestring or null(date)obrigatório

The date of the invoice cancelation, in YYYY-MM-DD format.

Exemplo: "2019-12-02"
certification_datestring or null(date)obrigatório

The date of the fiscal certification, in YYYY-MM-DD format.

Exemplo: "2019-12-01"
certification_authoritystring or nullobrigatório

The fiscal ID of the certification provider.

Exemplo: "CCC333333CC33"
payment_typestring or nullobrigatório

The payment type code used for this invoice, as defined by the country legal entity.

Exemplo: "99"
payment_methodstring or null

The payment method code used for this invoice, as defined by the legal entity of the country.

Enum"PUE""PPD"null
Exemplo: "PUE"
usagestring or null

The invoice's usage code, as defined by the legal entity of the country.

Exemplo: "P01"
versionstring or null

The CFDI version of the invoice.

Exemplo: "3.3"
place_of_issuestring or null

The postcode of where the invoice was issued.

Exemplo: "01165"
invoice_detailsArray of objectsobrigatório

A list of descriptions for each item (purchased product or service provided) in the invoice.

collected_atstring(date-time)

The ISO-8601 timestamp when the data point was collected.

Exemplo: "2022-02-09T08:45:50.406032Z"
descriptionstring or nullobrigatório

The description of the invoice item (an invoice can have one or more items).

Exemplo: "December 2019 accounting fees"
product_identificationstring or nullobrigatório

The identification code of the product or the service, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico.

Exemplo: "84101600"
quantitynumber or null(float)obrigatório

The quantity of this invoice item.

Exemplo: 10
unit_codestring or nullobrigatório

The unit of measure, as defined by the legal entity in the country. \n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference.

Exemplo: "E48"
unit_descriptionstring or nullobrigatório

The description of the item, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference.

Exemplo: "Unidad de servicio"
unit_amountnumber or null(float)obrigatório

The price of one a singular item.

Exemplo: 200
tax_typestring or null

The item's tax type.

Exemplo: null
pre_tax_amountnumber or null(float)obrigatório

The total price for this item before tax is applied (quantity x unit_amount).

Exemplo: 400
tax_percentagenumber or null(float)obrigatório

The tax percentage to apply.

Exemplo: 16
tax_amountnumber or null(float)obrigatório

The amount of tax for this invoice item (pre_tax_amount x tax_percentage).

Exemplo: 64
total_amountnumber or null(float)obrigatório

The total price for this invoice item (pre_tax_amount + tax_amount).

Exemplo: 464
retained_taxesArray of objects

The retained tax on the invoice item.

transferred_taxesArray of objects

The transferred taxes related to the invoice.

currencystring or nullobrigatório

The currency of the invoice. For example:

  • 🇧🇷 BRL (Brazilian Real)
  • 🇨🇴 COP (Colombian Peso)
  • 🇲🇽 MXN (Mexican Peso)
  • 🇺🇸 USD (United States Dollar)
Exemplo: "MXN"
subtotal_amountnumber or null(float)obrigatório

The pretax amount of this invoice (sum of each item's pre_tax_amount).

Exemplo: 400
exchange_ratenumber or null(float)obrigatório

The exchange rate used in this invoice for the currency.

Exemplo: 0.052
tax_amountnumber or null(float)obrigatório

The amount of tax for this invoice (sum of each item's tax_amount).

Exemplo: 64
discount_amountnumber or null(float)obrigatório

The total amount discounted in this invoice.

Exemplo: 10
total_amountnumber or null(float)obrigatório

The total amount of the invoice (subtotal_amount + tax_amount - discount_amount)

Exemplo: 454
related_invoicesArray of objects

A list of related invoices.

paymentsArray of objectsobrigatório

A list detailing all the invoice payments.

datestring or null(date-time)obrigatório

ISO-8601 timestamp when the payment was made.

Exemplo: "2020-03-17T12:00:00.000Z"
payment_typestring or nullobrigatório

Payment type code used for this invoice, as defined by the country's legal entity.

Exemplo: "03"
currencystring or nullobrigatório

The currency of the payment. For example:

  • 🇧🇷 BRL (Brazilian Real)
  • 🇨🇴 COP (Colombian Peso)
  • 🇲🇽 MXN (Mexican Peso)

Please note that other currencies other than in the list above may be returned.

Exemplo: "BRL"
exchange_ratestring or nullobrigatório

The currency to MXN currency exchange rate when the payment was made.

Exemplo: "3.75"
amountnumber or null(float)obrigatório

The invoice amount, in the currency of the original invoice.

Exemplo: 8000.5
operation_numberstring or nullobrigatório

The fiscal institution's internal identifier for the operation.

Exemplo: "831840"
beneficiary_rfcstring or null

The fiscal ID of the payment beneficiary.

Exemplo: "BNM840515VB1"
beneficiary_account_numberstring or nullobrigatório

The bank account number of the payment beneficiary.

Exemplo: "12343453245633"
payer_rfcstring or nullobrigatório

The fiscal ID of the payment issuer.

Exemplo: "BKJM840515VB1"
payer_account_numberstring or nullobrigatório

The bank account number of the payment issuer.

Exemplo: "13343663245699"
payer_bank_namestring or nullobrigatório

The banking institution that was used by the payment issuer.

Exemplo: "CITI BANAMEX"
related_documentsArray of objectsobrigatório

A list of all the related deferred invoices affected by the payment.

invoice_identificationstring or nullobrigatório

The fiscal institution's unique ID for the related deferred invoice.

Exemplo: "7EE015F3-6311-11EA-B02A-00155D014007"
currencystring or nullobrigatório

The currency of the related invoice. For example:

  • 🇧🇷 BRL (Brazilian Real)

  • 🇨🇴 COP (Colombian Peso)

  • 🇲🇽 MXN (Mexican Peso)

    Please note that other currencies other than in the list above may be returned.

Exemplo: "MXN"
payment_methodstring or nullobrigatório

The payment method of the related invoice.

Exemplo: "PPD"
partiality_numberinteger(int32)

The payment installment number.

Exemplo: 1
previous_balancenumber or null(float)obrigatório

The invoice amount before the payment.

Exemplo: 18877.84
amount_paidnumber or null(float)obrigatório

The amount paid in this installment.

Exemplo: 8000
outstanding_balancenumber or null(float)obrigatório

The amount remaining to be paid.

Exemplo: 10877.84
payrollobject or nullobrigatório

Details regarding the payroll payment. Only applicable for payroll invoices.

daysinteger or null(int32)obrigatório

The number of days covered by the payment.

Exemplo: 30
typestring or nullobrigatório

The payroll type, as defined by the legal entity of the country.

Exemplo: "O"
amountnumber(float)obrigatório

The total amount of the payroll payment.

Exemplo: 20400.1
versionstringobrigatório

The version of the payroll object.

Exemplo: "1.2"
date_fromstring or null(date)obrigatório

The start date of the payment period, in YYYY-MM-DD format.

Exemplo: "2018-07-01"
date_tostring or null(date)obrigatório

The end date of the payment period, in YYYY-MM-DD format.

Exemplo: "2018-07-31"
collected_atstring(date-time)

The ISO-8601 timestamp when the data point was collected.

Exemplo: "2022-02-09T08:45:50.406032Z"
payment_datestring(date)obrigatório

The payment date, in YYYY-MM-DD format.

Exemplo: "2018-07-16"
periodicitystring or null

How often the payroll payment is made.

For Mexico's SAT, we return one of the following values:

  • DAILY
  • WEEKLY
  • TENTH_DAY
  • FOURTEENTH_DAY
  • FIFTEENTH_DAY
  • MONTHLY
  • BIMONTHLY
  • PER_TASK
  • COMMISSION
  • ONE_OFF
  • OTHER_PERIODICITY
Enum"DAILY""WEEKLY""TENTH_DAY""FOURTEENTH_DAY""FIFTEENTH_DAY""MONTHLY""BIMONTHLY""PER_TASK""COMMISSION""ONE_OFF"
Exemplo: "MONTHLY"
earnings_breakdownArray of objects or null or null

A breakdown of the earnings for the payroll payment.

tax_deductionsArray of objects or null or null

A breakdown of the tax deductions on the payroll payment.

other_paymentsArray of objects or null or null

A breakdown of other payments for the payroll.

foliostring or null

The internal control number that the taxpayer assigns to the invoice.

Exemplo: "26"
export_typestring or null

The export type of the invoice, as defined by the legal entity in the country. For more information, see our SAT catalog reference article.

Exemplo: "01"
xmlstring or null

XML of the invoice document.

warningsobject or null

Object containing information about any warnings related to this invoice.

payment_type_descriptionstring or nullObsoletoobrigatório

This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.

Exemplo: null
payment_method_descriptionstring or nullObsoleto

This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.

The description of the payment method used for this invoice.

Exemplo: null
sender_blacklist_statusstring or nullObsoleto

This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation. Please use sender_tax_fraud_status instead.

Exemplo: null
receiver_blacklist_statusstring or nullObsoleto

This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation. Please use receiver_tax_fraud_status instead.

Exemplo: null
Resposta
application/json

Example of an Igreso type invoice.

{
  "id": "90d90e38-0087-4b6d-b6dc-94ea561bb9cb",
  "link": "1bd948f7-245d-4313-b604-34d1044cb908",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:46:20.406032Z",
  "invoice_identification": "862B9918-3K6H-4E0B-NAI9-2BE2D833B840",
  "invoice_date": "2020-12-24",
  "status": "Vigente",
  "invoice_type": "Ingreso",
  "type": "OUTFLOW",
  "sender_id": "GHTF980303F7",
  "sender_name": "Roberto Martinez Diaz",
  "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS",
  "receiver_id": "MNMK3203409H1",
  "receiver_name": "ACNE SA DE CV",
  "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS",
  "cancelation_status": null,
  "cancelation_update_date": null,
  "certification_date": "2020-12-24",
  "certification_authority": "FGV330542BG6",
  "payment_type": "04",
  "payment_type_description": null,
  "payment_method": "PUE",
  "usage": "G03",
  "place_of_issue": "11000",
  "version": "3.3",
  "invoice_details": [
    { … }
  ],
  "currency": "MXN",
  "subtotal_amount": 25,
  "exchange_rate": 1,
  "tax_amount": 4,
  "discount_amount": 0,
  "total_amount": 29,
  "payments": [],
  "payroll": null,
  "folio": "28",
  "xml": "=XML-STRING=",
  "warnings": {
    "code": "warning_code",
    "message": "warning message"
  }
}

Delete an invoice

Requisição

Delete a specific invoice from your Belvo account.

Segurança
basicAuth
Caminho
idstring(uuid)obrigatório

The invoice.id that you want to delete.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://sandbox.belvo.com/api/invoices/{id}/'

Respostas

No content

Resposta
Sem conteúdo

Tax compliance status

Operações

Tax returns

Operações

Tax retentions

Operações

Tax status

Operações

Financial Statements

Operações

Invoices Chile

Operações

Tax Status Chile

Operações

Debt Reports Chile

Operações

Incomes

Use the Incomes endpoint to gather insights on an account's income sources for the past 365 days. The endpoint is particularly useful when you want to verify a person's income.

📘 Info

The incomes resource is only available for Checking and Savings accounts associated with banking links.

Operações

Recurring Expenses

Belvo's Recurring Expenses API allows you to identify a user's regular payments for subscription services, such as Netflix or gym memberships, as well as utility payments, such as electricity or phone bills. We return information for up to 365 days.

📘 Info

The recurring expenses resource is only available for Checking, Savings and Credit Card accounts associated with banking links.

Operações

Risk Insights

Operações

Employment Metrics

Operações

Payment Institutions (Brazil)

A payment institution is an entity that Belvo can access information from. You can see a complete list of institutions available for payments by making a List request to this endpoint.

Operações

Customers (Brazil)

A customer is the payer that's going to push funds into your bank account. You need to create a customer in order to receive inflow payments to your organization's bank account.

Resource Versioning

This endpoint supports resource-level versioning. By including the header X-Belvo-API-Resource-Version: Payments-BR.V2, you can access the latest (V2) request and response formats. If the header is not provided, the default (V1) format will be used. See the API documentation for details on the differences between versions.

Operações

Bank Accounts (Brazil)

To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.

  • Individual bank accounts must be created for each payer (your customer).
  • Business bank accounts need to be created for the beneficiary of the payment (your organization).
Resource Versioning

This endpoint supports resource-level versioning. By including the header X-Belvo-API-Resource-Version: Payments-BR.V2, you can access the latest (V2) request and response formats. If the header is not provided, the default (V1) format will be used. See the API documentation for details on the differences between versions.

Operações

Payment Authorizations (Brazil)

A Payment Authorization is the consent that your user gives you to charge (debit money from) their accounts. You need to perform one Payment Authorization per ‘contract’ (for example, if your company does both electricity and water but they are billed separately, then you will create two separate Payment Authorizations).

Once the user confirms the authorization, you will need to listen for a a PAYMENT_AUTHORIZATION webhook with the status set to AUTHORIZED. Once you receive this webhook, the authorization process is complete, and you will be able to charge your user.

What is a charge?

A charge represents the individual payment (debit) that your customer will make.

Version Header

The Payment Authorization resource requires that you send through the X-Belvo-API-Resource-Version header set to Payments-BR.V2.

Operações

Charges (Brazil)

Operações

Payment Intents (Brazil)

A payment intent is a single point of access to create payments using any payment method offered by Belvo.

A payment intent captures all payment information (such as the amount to be charged, the description of the payment, the provider, and so on) and guides your customers through the payment flow.

Note: For institutions that require the username_type in the form_fields array, you must send through this value in your PATCH request.

Operações

Biometric Pix Widget Access Token (Brazil)

Use the Biometric Pix Widget Token requests to create a access token for Biometric Payments.

Operações

Enrollments (Brazil)

Operações

Payment Transactions (Brazil)

Each time you receive an inflow payment from your customer, a transaction is created in the Belvo database.

You can use the Payment Transactions resource in order to get useful information about a transaction as well as the specific charge associated with it.

Operações
Copyright © 2020-2025 Belvo. All rights reserved