Register your organization bank account

POST {{baseUrl}}/payments/br/bank-accounts/

Documentation 😍

Let's register your organization's bank account (just to be clear: this is the bank account that will receive all payments from your users).

You can create a bank account using your account information

Once you register your bank account, make sure to save the id from the response to use it as the beneficiary_bank_account in your future Payment Link calls.

We save this id for you in our OFPI collection as an environment variable, just to make things easier for you.

Using your account information

The request body when using your account information will look like this (it's the default example in our Qodex collection):

{
  "holder": {
    "type": "BUSINESS",
    "information": {
      "identifier_type": "CNPJ",
      "identifier": "Your_CNPJ_ID_number",
      "name": "Your_Company_Name"
    }
  },
  "details": {
    "country": "BRA",
    "account_type": "Either_CHECKINGS/SAVINGS/SALARY",
    "agency": "Your_agency_number",
    "number": "Your_bank_account_number"
  },
  "institution": "Your_institution's_Belvo_ID"
}

Request Body

{"holder"=>{"type"=>"INDIVIDUAL", "information"=>{"identifier_type"=>"CNPJ", "identifier"=>"your_CNPJ_number", "name"=>"your_business_name"}}, "details"=>{"country"=>"BRA", "account_type"=>"Either_CHECKINGS/SAVINGS/SALARY", "agency"=>"your_agency_number", "number"=>"your_bank_account_number"}, "institution"=>"your_institution_id"}