Desativar / Encerrar uma Conta
Essa funcionalidade permite ao cliente desativar ou encerrar uma conta do BaaS, seja por motivos de segurança ou opção do cliente.
Passos para Desativar uma conta
- Realizar autenticação na API - [API Reference]
- Desativar uma conta - [API Reference]
Diferença entre Desativar e Encerrar uma conta.
- Ao Desativar uma conta, você pode reativar ela posteriormente;
- Ao Encerrar uma conta você não pode reativa-la posteriormente;
Regras para Desativar e Encerrar uma conta
- Você pode Desativar qualquer conta, com saldo ou sem;
- Para Encerrar uma conta a conta não pode ter saldo;
Desativar uma conta
cURL da chamada
curl --request PUT \
--url 'https://sandbox.openfinance.celcoin.dev/baas-accountmanager/v1/account/status?Account=123456' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '
{
"status": "BLOQUEADO",
"reason": "Segurança"
}
'
| Status |
|---|
| BLOQUEADO |
| ATIVO |
Exemplo de retorno
Sucesso 200
{
"version": "0.1.0",
"status": "SUCCESS"
}
Error 400
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE072",
"message": "Status é obrigatório."
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE072 | Status é obrigatório. |
| CBE073 | É necessário informar pelo menos um dos campos: account, ou documentNumber. |
| CBE074 | reason é obrigatório. |
| CBE077 | Status deve ser 'BLOQUEADO' ou 'ATIVO'. |
| CBE039 | Account invalido. |
| CBE040 | DocumentNumber invalido. |
| CBE041 | Account possui tamanho maximo de 20 caracteres. |
| CBE042 | DocumentNumber possui tamanho maximo de 14 caracteres. |
| CBE043 | reason possui tamanho maximo de 300 caracteres. |
Passos para Encerrar uma conta
- Realizar autenticação na API - [API Reference]
- Encerrar uma conta - [API Reference]
Encerrar Conta
cURL da chamada
curl --request DELETE \
--url 'https://sandbox.openfinance.celcoin.dev/baas-accountmanager/v1/account/close?Account=123456&Reason=Fraude' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"version": "0.1.0",
"status": "SUCCESS"
}
Error 400
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api.."
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE073 | É necessário informar pelo menos um dos campos: account, ou documentNumber. |
| CBE074 | reason é obrigatório. |
| CBE062 | Não é permitido encerrar conta com saldo. |
| CBE075 | Conta já foi encerrada. |
| CBE039 | Account invalido. |
| CBE040 | DocumentNumber invalido. |
| CBE041 | Account possui tamanho maximo de 20 caracteres. |
| CBE042 | DocumentNumber possui tamanho maximo de 14 caracteres. |
| CBE043 | reason possui tamanho maximo de 300 caracteres. |
Updated 5 months ago