Skip to main content
GET
Consultar conta bancária

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-secret
string
required

Secret da credencial do merchant

client-id
string
required

ID público da credencial do merchant

Path Parameters

internalId
string<uuid>
required

Identificador interno (UUID) da subconta

Response

Conta bancária retornada com sucesso

bankingDataType
enum<string>

Tipo dos dados bancários

Available options:
bank_account,
chave_pix
Example:

"bank_account"

bankName
string

Nome do banco

Example:

"banco do brasil"

bankAgency
string

Agência bancária

Example:

"1234"

bankAccount
string

Número da conta bancária

Example:

"56789"

bankAccountDv
string

Dígito verificador da conta

Example:

"0"

bankAccountType
enum<string>

Tipo da conta bancária

Available options:
conta_corrente,
conta_poupanca
Example:

"conta_corrente"

bankCode
string

Código do banco (compe)

Example:

"001"

ispb
string

ISPB da instituição financeira

Example:

"00000000"

pixType
enum<string>

Tipo da chave PIX. Retornado exatamente como persistido, sem normalização.

Available options:
cpf,
cnpj,
email,
phone,
EVP
Example:

"cpf"

pixKey
string

Valor da chave PIX

Example:

"12345678900"