Skip to main content
POST
/
validate
/
account
Validar Conta Bancária
curl --request POST \
  --url https://production.api.noodle.cx/external/validate/account \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "bankCode": "<string>",
  "pspId": "<string>",
  "agency": "<string>",
  "account": "<string>",
  "accountType": "<string>",
  "pixKeyType": "<string>",
  "pixDescription": "<string>",
  "pixKey": "<string>",
  "taxId": "<string>",
  "validateOwnership": true
}
'
{
  "valid": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json

Representa os dados para validar uma conta bancária ou chave Pix para pagamentos. Atributos:

  • tax_id (str, opcional): CPF ou CNPJ do titular da conta, necessário para validar a propriedade da conta.
  • validate_ownership (bool, opcional): Indica se a propriedade da conta deve ser validada, padrão é True.
  • name (str, opcional): Nome do titular da conta.
  • bank_code (str, opcional): Código do banco.
  • psp_id (str, opcional): Identificador do provedor de serviços de pagamento (PSP).
  • agency (str, opcional): Número da agência bancária.
  • account (str, opcional): Número da conta bancária.
  • account_type (str, opcional): Tipo da conta bancária, deve ser um dos valores: "saving_account", "payment_account", "checking_account" ou "salary_account".
  • pix_key_type (str, opcional): Tipo da chave Pix, deve ser um dos valores "random_key", "cnpj", "cpf", "phone_number" ou "email".
  • pix_description (str, opcional): Descrição da chave Pix.
  • pix_key (str, opcional): Chave Pix associada à conta. Validações:
  • Pelo menos um dos campos pix_key ou account deve ser informado.
  • Se pix_key for informado, o campo pix_key_type é obrigatório.
  • Para contas bancárias, os campos agency, psp_id, account_type, name e bank_code são obrigatórios.
  • Se validate_ownership for True, o campo tax_id é obrigatório.
​
name
string | null
​
bankCode
string | null
​
pspId
string | null
​
agency
string | null
​
account
string | null
​
accountType
string | null
​
pixKeyType
string | null
​
pixDescription
string | null
​
pixKey
string | null
​
taxId
string | null
​
validateOwnership
boolean | null
default:true

Response

Successful Response

Resposta da validação de conta bancária.

Atributos:

  • valid (bool): Indica se a conta é válida.
  • message (str): Mensagem descritiva do resultado da validação.
​
valid
boolean
required

Indica se a conta é válida.

​
message
string
required

Mensagem descritiva do resultado da validação.