Ir para o conteúdo

Gerenciamento das contas correntes vinculadas ao cedente.


Listar Contas Correntes

Método URL
GET https://BASE_URL/public/api/v1/cedentes/{idEmpresa}/contas

Lista as contas correntes ativas do cedente — útil para obter o idConta usado no vínculo com operações.

Response Body
[
  {
    "idConta": 10,
    "codigoBanco": "341",
    "nomeBanco": "Itau Unibanco",
    "agencia": "1234",
    "conta": "56789",
    "tipoConta": 1,
    "descricao": "Conta principal",
    "principal": true
  }
]
Campo Tipo Descrição
idConta Número Identificador da conta corrente.
codigoBanco Texto Código COMPE do banco.
nomeBanco Texto Nome do banco.
agencia Texto Número da agência.
conta Texto Número da conta.
tipoConta Número Tipo da conta. Ver Tipo de Conta.
descricao Texto Apelido/descrição da conta.
principal Booleano Indica se é a conta principal.

Adicionar Conta Corrente

Método URL
POST https://BASE_URL/public/api/v1/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
PUT https://BASE_URL/public/api/v1/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
DELETE https://BASE_URL/public/api/v1/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