Sign in

v1

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

Get details about a bank account

Get the details about a specific bank account

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

Path parameters

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

The bank-account.id you want to get detailed information about.

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

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