Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Bank Accounts (Brazil)

Activate or deactivate a bank account

Updates whether a bank account is active by setting active to true or false.

Setting active to false deactivates the bank account identified in the path. Deactivated accounts are ignored for duplicate checks on the same institution, agency, and account number, which lets you register a new bank account with the same banking details when you need to fix incorrect holder information (such as name or CPF/CNPJ) or similar mistakes from an initial registration.

patch/payments/br/bank-accounts/{id}/

Path parameters

idstring uuid required
Example:a3b92311-1888-449f-acaa-49ae28d68fcd

The bank-account.id you want to activate or deactivate.

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, then you must send through this header set to Payments-BR.V2.

{% admonition type="warning" name="Coming Soon" %} This version is in Coming Soon. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

Request body

activeboolean required

When set to false, deactivates this bank account. A deactivated account no longer counts toward uniqueness for the same institution, agency, and account number, so you can register a new bank account with the same banking details (for example, after correcting the holder name, CPF/CNPJ, or other metadata).

When set to true, reactivates a previously deactivated bank account.

Response

OK

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"
  }
}