Gerenciamento das contas correntes vinculadas ao cedente.
Adicionar Conta Corrente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contas |
Request Body
{
"codigoBanco": "341",
"agencia": "1234",
"conta": "56789",
"digito": "0",
"tipoConta": 1,
"descricao": "Conta principal"
}
Response Body
{
"idConta": 10,
"idEmpresa": 123,
"status": "Conta corrente adicionada com sucesso."
}
Atualizar Conta Corrente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contas/{idConta} |
Somente os campos enviados serão atualizados.
Request Body
{
"agencia": "5678",
"descricao": "Conta atualizada"
}
Response Body
{
"idConta": 10,
"status": "Conta corrente atualizada com sucesso."
}
Remover Conta Corrente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contas/{idConta} |
Response Body
{
"status": "Conta corrente removida com sucesso."
}
Modelo de Dados¶
Requisição — Conta Corrente¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
codigoBanco | Texto (10) | ✅ | Código do banco (COMPE ou ISPB) |
agencia | Texto (10) | ✅ | Número da agência (sem dígito) |
conta | Texto (20) | ✅ | Número da conta (sem dígito) |
digito | Texto (2) | ✅ | Dígito verificador da conta |
tipoConta | Número | Opcional | Tipo da conta. Ver Tipo de Conta. Default: 1 |
descricao | Texto (200) | Opcional | Descrição/apelido da conta |
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
idConta | Número | ID da conta corrente |
idEmpresa | Número | ID da empresa cedente |
status | Texto | Mensagem de status da operação |