Bank Accounts (Brazil)

Register a new bank account

Register a new bank account from which to send or request funds.

post/payments/br/bank-accounts/

Request

Headers

X-Belvo-API-Resource-Version'Payments-BR.V2'
Example:Payments-BR.V2

Header indicating which version of the Payment API you want to use. Currently this is only applicable for Bank Accounts, Customers, and Payment Authorizations in Brazil. In the case that you are using our Payment Authorizations product (including Smart Transfers authorizations and their Charges), then you must send through this header set to Payments-BR.V2.

Request body

OR
OR

Example request

{
  "holder": {
    "name": "Frangos Enlatados",
    "identifier": "12345678901122"
  },
  "details": {
    "account_type": "CHECKINGS",
    "agency": "0444",
    "institution": "f512d996-583a-4a91-8b5b-eba2e103b068",
    "number": "457220"
  },
  "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
  "metadata": {
    "internal_reference_id": "GGq73487w2"
  }
}

Response

OK (Created)

OR

Example response

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "updated_at": "2022-02-09T08:45:50.406032Z",
  "active": true,
  "holder": {
    "name": "Frangos Enlatados",
    "identifier": "12345678901122"
  },
  "details": {
    "institution": "f512d996-583a-4a91-8b5b-eba2e103b068",
    "account_type": "CHECKINGS",
    "agency": "0444",
    "number": "457220"
  },
  "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
  "metadata": {
    "internal_reference_id": "GGq73487w2"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.