Skip to main content
POST
/
contacts
/
accounts
Criar Conta do Contato
curl --request POST \
  --url https://production.api.noodle.cx/external/contacts/accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_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>"
}
'
{
  "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

Body

application/json

Representa a requisição externa para adicionar uma conta bancária a um contato.

Atributos:

  • contact_id (str): ID do contato ao qual a conta será associada.
  • bank_name (str, opcional): Nome do banco.
  • bank_code (str, opcional): Código do banco.
  • bank_ispb (str, opcional): Código ISPB do banco.
  • agency (str, opcional): Número da agência bancária.
  • account_number (str, opcional): Número da conta bancária.
  • account_type (str, opcional): Tipo da conta (ex: 'checking_account').
  • pix_key (str, opcional): Chave PIX associada à conta.
  • pix_key_type (str, opcional): Tipo da chave PIX (ex: 'cpf', 'email').

Validações:

  • É obrigatório fornecer os dados de uma chave PIX (pix_key) ou os dados de uma conta bancária completa (account_number, agency, etc.).
  • Se uma pix_key for informada, o campo pix_key_type também é obrigatório.
  • Se os dados de conta bancária forem informados, os campos agency, bank_ispb, account_type, bank_name e bank_code são obrigatórios.
  • O campo pix_key_type deve ser um dos valores permitidos.
  • O campo account_type deve ser um dos valores permitidos.
​
contact_id
string
required

ID do contato ao qual a conta será associada.

​
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: 'checking_account').

​
pix_key
string | null

Chave PIX associada à conta.

​
pix_key_type
string | null

Tipo da chave PIX (ex: 'cpf', 'email').

Response

Successful Response

Representa os dados da conta bancária de um contato.

Atributos:

  • id (str, opcional): Identificador único da conta.
  • bank_name (str, opcional): Nome do banco.
  • bank_code (str, opcional): Código do banco.
  • bank_ispb (str, opcional): Código ISPB do banco.
  • agency (str, opcional): Número da agência bancária.
  • account_number (str, opcional): Número da conta bancária.
  • account_type (str, opcional): Tipo da conta (ex: Corrente, Poupança).
  • pix_key (str, opcional): Chave PIX associada à conta.
  • pix_key_type (str, opcional): Tipo da chave PIX (ex: CPF, Email, Telefone).
  • tax_id (str, opcional): CPF ou CNPJ do titular da conta.
  • tax_id_manager (str, opcional): CPF ou CNPJ do gestor que cadastrou a conta.
  • contact_id (str, opcional): ID do contato ao qual a conta pertence.
  • is_favorite (bool, opcional): Indica se a conta é a favorita do contato.
​
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.