Get Bank Account
GET {{url_contbank}}/accounts/information
Endpoint responsável por retornar as informações da conta bancária do cliente. Para isto, será necessário consultar a partir do CPF/CNPJ dele.
Header
O CPF/CNPJ deve ser repassado no X-Current-Identity, no header da requisição.
Agência e Conta
As informações retornadas nesta consulta são fundamentais para o acionamento de outros endpoints, como por exemplo, a geração de cobranças (billings). É a partir da informação de agência (branch) e conta (number) que conseguiremos identificar para qual cliente você, integrador, deseja emitir.
Response Schema - 200 Ok
| Key | Value |
|---|---|
| status | Indica o status da conta, podendo ser ATIVA ou INATIVA. |
| branch | Indica o número da agência da conta. |
| number | Indica o número da conta. |
| account_id | Indica o id da conta, necessário para geração de cobranças. |
Response Schema - 403 Forbidden
Quanto retornado o código 403, significa que você não possui permissão de acesso aos dados do CPF/CNPJ informado.
Response Schema - 404 Not Found
Ao acionar este endpoint e obter o código 404 como retorno, significa que o cliente em questão ainda não concluiu a abertura da sua conta, portanto não tendo resultado a ser apresentado e não sendo possível gerar operações para este cliente.
No momento em que o cliente concluir a abertura, automaticamente você terá acesso e então, este endpoint começará a retornar os dados esperados (response code 200).
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Current-Identity | number | CNPJ/CPF do cliente para consulta dos dados bancários. |
RESPONSES
status: OK
{"account_id":"000a1c100dc010f2a982dc00","status":"APPROVED","number":"444411111","branch":"0001"}