Contas do cedente
As contas de desembolso podem ser enviadas já no cadastro do cedente (accounts) ou adicionadas depois por esta página. O cedente precisa ter ao menos uma conta para que um contrato de cessão seja proposto. Na etapa de aprovação da cessão pela gestora, é possível indicar qualquer uma das contas cadastradas para o cedente para ocorrer o desembolso da mesma.
Diferente de dados cadastrais, como representantes, endereços, e outros dados, não será criada uma nova análise ao realizar uma alteração nas contas do cedente, sendo assim, a alteração passa a valer de imediato. Para uma conta de desembolso, obrigatoriamente o titular da conta deve ser o cedente, inclusive a titularidade da conta, e o número de documento do dono da conta já é assumido ser o do cedente.
Muito cuidado ao preencher os dados da conta. Caso a conta seja inválida, o pagamento da cessão não ocorrerá, e toda a operação será cancelada.
As rotas de conta não estão disponíveis em manager-api. A manutenção das contas do cedente é feita pela consultoria (consultant-api) ou pelo próprio cedente (assignor-api). Uma gestora que precise incluir ou desativar uma conta deve enviá-la já no cadastro inicial do cedente (accounts), pedir à consultoria ou ao cedente, ou falar com o time de integração em integracao.dtvm@qitech.com.br.
Adição de conta alternativa
| Perfil | Host | Permissão exigida |
|---|---|---|
| Consultoria | consultant-api | Cadastrar Cedente |
| Cedente | assignor-api | Escrita |
URL base de cada host: Ambientes (Hosts).
Request
{
"account_number": "8473124",
"account_digit": "8",
"account_branch": "0001",
"account_type": "checking_account",
"financial_institution_code": "329",
"default_account": false
}
Objeto de Conta
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_number * | string | Número da conta. | 3-20 |
account_digit * | string | Dígito da conta. | 1 |
account_branch * | string | Agência da conta. | 4 |
account_type * | string | Tipo da conta. | - |
financial_institution_code * | string | Código do banco da conta. | 3 |
default_account * | boolean | Conta padrão de desembolso. | - |
*Campos obrigatórios.
Response
{
"account_key": "3c53a94a-2b81-4837-b7eb-8e025e69d81c",
"account_branch": "0001",
"account_number": "8473124",
"account_digit": "8",
"account_type": "checking_account",
"status": "active",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502",
"default_account": false
}
Caso a conta nova seja enviada com "default_account" true, a antiga conta padrão de desembolso será tornada uma conta não padrão, e a partir de então, a nova conta postada será a padrão de desembolso.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado. Verificar se o assignor_registry_key está correto. |
| 409 | ASR000072 | Já existe uma conta ativa com a mesma combinação de banco, agência, conta e dígito. Não enviar contas duplicadas — verificar as contas já cadastradas para o cedente. |
| 400 | ASR000087 | Informação de conta deve conter apenas números. Enviar account_branch, account_number, account_digit e financial_institution_code apenas com dígitos. |
| 404 | ASR000071 | Instituição financeira não encontrada. Validar o financial_institution_code (código bancário) informado. |
Erros de autenticação, permissão e host: veja Erros da API.
Atualização de conta
Não é possível alterar os dados de uma conta. Caso deseje, é necessário desativar a conta errada, e criar uma nova conta com os dados válidos.
Para alterar a conta padrão de desembolso, basta indicar qual será a nova conta, que a antiga será alterada automaticamente. Não é possível definir uma conta como não padrão de desembolso, deve-se sempre indicar a nova.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Consultoria | consultant-api | Cadastrar Cedente |
| Cedente | assignor-api | Escrita |
URL base de cada host: Ambientes (Hosts).
Request
{
"status": "active",
"default_account": true
}
Objeto de Conta
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
status | string | Novo status da conta. | Ver Enumeradores de status de conta. |
default_account | boolean | Só aceita true: torna esta a conta padrão de desembolso. | - |
Envie ao menos um dos dois campos.
Response
{
"account_key": "3c53a94a-2b81-4837-b7eb-8e025e69d81c",
"account_branch": "0001",
"account_number": "8473124",
"account_digit": "8",
"account_type": "checking_account",
"status": "active",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502",
"default_account": true
}
Caso a atualização seja enviada com "default_account" true, a antiga conta padrão de desembolso será tornada uma conta não padrão, e a partir de então, a nova conta postada será a padrão de desembolso. Não é possível desativar uma conta padrão, ou definir como padrão uma conta inativa.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado. Verificar se o assignor_registry_key está correto. |
| 404 | ASR000073 | Conta não encontrada para o account_key informado. Verificar se o account_key pertence ao cedente. |
| 400 | ASR000074 | Não é possível desativar/desmarcar uma conta padrão. Indicar primeiro outra conta como padrão (default_account=true em outra conta) antes de inativar a atual. |
| 400 | ASR000075 | Nenhuma informação foi enviada para atualização. Informar status ou default_account no corpo da requisição. |
Erros de autenticação, permissão e host: veja Erros da API.
Enumeradores
Account Status
| Enumerador | Descrição |
|---|---|
| active | Conta ativa e disponível como opção de desembolso. |
| inactive | Conta inativa e indisponível para desembolso. |