Skip to main content
POST
Inserir Conta Corrente
Campos obrigatórios ausentes ou inválidos retornam 400 com o detalhe em notifications/errors.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Conta Corrente bancária. Usada tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na inclusão, quando codigoDoBanco e codigoDaAgencia são ambos omitidos, apenas os dados básicos (descrição) são exigidos; se qualquer um deles for informado, ambos passam a ser obrigatórios e a combinação deve existir previamente cadastrada. Na alteração, codigoDaContaCorrente é obrigatório para identificar o registro.

descricaoDaContaCorrente
string | null
required

Nome/descrição da Conta Corrente. Obrigatório.

Example:

"Banco do Brasil - CC 12345-6"

codigoDaContaCorrente
integer<int16>

Código da Conta Corrente. Ignorado e gerado automaticamente na inclusão; obrigatório na alteração.

Example:

1

codigoDoConvenio
string | null

Código do Convênio junto ao banco, usado em integrações de cobrança/pagamento.

codigoDoBanco
integer<int32> | null

Código do Banco (compensação). Quando informado, codigoDaAgencia também passa a ser obrigatório, e a combinação Banco/Agência deve existir previamente cadastrada.

Example:

1

codigoDaAgencia
integer<int32> | null

Código da Agência. Quando informado, codigoDoBanco também passa a ser obrigatório.

Example:

10

numeroDaContaCorrente
string | null

Número da Conta Corrente, podendo incluir o dígito separado por hífen (ex.: 12345-6).

Example:

"12345-6"

cnpjDaContaCorrente
string | null

CNPJ vinculado à Conta Corrente. Quando informado, deve ser um CNPJ válido.

Example:

"12345678000199"

idContaCorrenteWS
string | null

Identificador externo da Conta Corrente (integração bancária).

idWebhookWS
string | null
considerarSaldoNoDashboard
boolean

Indica se o saldo desta Conta Corrente deve ser considerado no dashboard financeiro. Padrão true.

Example:

true

codigoDaFilial
integer<int16> | null

Código da Filial vinculada à Conta Corrente, quando informado deve ser uma Filial válida.

Example:

1

Response

Conta Corrente inserida com sucesso.

success
boolean
Example:

true

data
object

Conta Corrente bancária. Usada tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na inclusão, quando codigoDoBanco e codigoDaAgencia são ambos omitidos, apenas os dados básicos (descrição) são exigidos; se qualquer um deles for informado, ambos passam a ser obrigatórios e a combinação deve existir previamente cadastrada. Na alteração, codigoDaContaCorrente é obrigatório para identificar o registro.