Skip to main content
GET
/
api
/
v1
/
ops
/
bank-accounts
Get Bank Account
curl --request GET \
  --url https://api.example.com/api/v1/ops/bank-accounts \
  --header 'Authorization: Bearer <token>'
{
  "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalProvider": "<string>",
  "externalProviderId": "<string>",
  "bankCode": "<string>",
  "bankName": "<string>",
  "agencyNumber": "<string>",
  "accountNumber": "<string>",
  "holderName": "<string>",
  "holderDocument": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Conta bancária vinculada a uma empresa para saques

​
bankAccountId
string<uuid>
required

Identificador único

​
organizationId
string<uuid>
required

Referência à organização da empresa

​
companyId
string<uuid>
required

Referência à empresa dona da conta

​
externalProvider
string
required

Nome do provedor externo

​
externalProviderId
string
required

ID da conta no provedor externo

​
bankCode
string
required

Código do banco

​
bankName
string
required

Nome do banco

​
agencyNumber
string
required

Número da agência

​
accountNumber
string
required

Número da conta

​
accountType
enum<string>
required

Tipo da conta

Available options:
CHECKING,
SAVINGS
​
holderName
string
required

Nome do titular

​
holderDocument
string
required

Documento do titular (normalizado e validado)

​
holderDocumentType
enum<string>
required

Tipo do documento do titular

Available options:
CPF,
CNPJ,
RG
​
status
enum<string>
required

Status da conta bancária

Available options:
ACTIVE,
INACTIVE
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização