Skip to main content
GET
/
contacts
/
accounts
Listar Contas do Contato
curl --request GET \
  --url https://production.api.noodle.cx/external/contacts/accounts \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "bank_name": "<string>",
    "bank_code": "<string>",
    "bank_ispb": "<string>",
    "agency": "<string>",
    "account_number": "<string>",
    "account_type": "<string>",
    "pix_key": "<string>",
    "pix_key_type": "<string>",
    "tax_id": "<string>",
    "tax_id_manager": "<string>",
    "contact_id": "<string>",
    "is_favorite": false
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
contact_id
string | null
​
tax_id
string | null

Response

Successful Response

​
id
string | null

Identificador único da conta.

​
bank_name
string | null

Nome do banco.

​
bank_code
string | null

Código do banco.

​
bank_ispb
string | null

Código ISPB do banco.

​
agency
string | null

Número da agência bancária.

​
account_number
string | null

Número da conta bancária.

​
account_type
string | null

Tipo da conta (ex: Corrente, Poupança).

​
pix_key
string | null

Chave PIX associada à conta.

​
pix_key_type
string | null

Tipo da chave PIX (ex: CPF, Email, Telefone).

​
tax_id
string | null

CPF ou CNPJ do titular da conta.

​
tax_id_manager
string | null

CPF ou CNPJ do gestor que cadastrou a conta.

​
contact_id
string | null

ID do contato ao qual a conta pertence.

​
is_favorite
boolean | null
default:false

Indica se a conta é a favorita do contato.