Skip to main content
GET
Visualizar conta bancária

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

account_hash
string
required

Hash da conta bancária

Response

Dados da conta bancária retornados com sucesso

code
string
required

Código único da conta bancária

holder_name
string | null
Maximum string length: 191
receiver_type
enum<string> | null
Available options:
pix,
bank
Maximum string length: 191
pix_key
string

Chave pix (pode ser nula)

Maximum string length: 191
bank_code
string

Código do banco

branch_number
string

Número da agência

Maximum string length: 20
branch_check_digit
string

Dígito da agência

Maximum string length: 3
account_number
string

Número da conta

Maximum string length: 20
account_check_digit
string

Dígito da conta

Maximum string length: 3
status
enum<string> | null

Status da conta bancária (approved = aprovada, pending = pendente, reproved = reprovada)

Available options:
approved,
pending,
reproved