DOCUMENTAÇÃO CORPORATIVA
1-[Open Banking WebAPI 1.0] ObterHistoricoFinanceiro
Este método tem como objetivo Obter o Histórico Financeiro de uma conta bancaria através dos dados da conta
Request
Campo | Tipo | Obrigatório | Descrição | |
---|---|---|---|---|
1 | codigoBanco | string | Sim | Código de compensação do banco. |
2 | agencia | string | Sim | Agência Bancária. |
3 | numeroConta | string | Sim | Número da conta bancária. |
4 | digitoConta | string | Sim | Dígito da conta bancária. |
5 | documento | string | Sim | Documento do titular da conta bancária. Em caso de Pessoa Física, informar CPF. |
Exemplo do Request
{
"codigoBanco": "655",
"agencia": "1111",
"numeroConta": "5772278",
"digitoConta": "3",
"documento": "50029019052"
}
Responses
200 Sucesso
| Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|---|
| HistoricoFinanceiroResponse | |||
1 | nomeCliente | string | Sim | Nome do titular da conta bancária |
2 | agencia | string | Sim | Agência bancária |
3 | numeroConta | string | Sim | Número da conta bancária com o dígito |
4 | saldoAtual | decimal | Sim | Saldo da conta bancária no momento da consulta |
5 | saldoAtualComLimeteDeCredito | string | Sim | Saldo da conta bancária com o Limite de Crédito no momento da consulta |
6 | transacoes | Array of objects | - | Últimas movimentações financeiras da conta bancária no momento da consulta |
| TransacaoHistoricoFinanceiroResponse | |||
---|---|---|---|---|
| Campo | TIpo | Obrigatório | Descriação |
6.1 | dataTransacao | string | Sim | Data de realização da transação financeira. |
6.2 | tipoTransacao | string | Sim | Tipo da transação financeira. |
6.3 | descricaoTransacao | string | Sim | Descrição da transação financeira. |
6.4 | valor | decimal | Sim | Valor da Transação financeira. |
Exemplo de Response 200 Sucesso
{
"nomeCliente": "Ivan Miguel de Paula Saavedra",
"agencia": "1111",
"numeroConta": "57722783",
"saldoAtual": 11.5100,
"saldoAtualComLimiteDeCredito": 11.5100,
"transacoes": [
{
"dataTransacao": "2020-10-07",
"tipoTransacao": "D",
"descricaoTransacao": "Transferencia entre Contas-Remetente-Cta Pgto",
"valor": -15.0000
},
{
"dataTransacao": "2020-10-02",
"tipoTransacao": "C",
"descricaoTransacao": "Transferencia entre Contas-Favorecido-Cta Pgto",
"valor": 1.0100
},
{
"dataTransacao": "2020-10-01",
"tipoTransacao": "C",
"descricaoTransacao": "Transferencia entre Contas-Favorecido-Cta Pgto",
"valor": 25.5000
}
]
}
Response para 400 Bad Request
Campo | Tipo | Obrigatório | Descrição | |
---|---|---|---|---|
1 | Response | |||
2 | type | string | Sim | Tipo do erro ocorrido. |
3 | message | string | Sim | Mensagem descritiva do(a) erro/exceção ocorrido(a). |
4 | validations | string | Sim | Validações gerais. Campo não utilizado nesse cenário. |
5 | exceptionType | decimal | Sim | Tipo da Exceção ocorrida. |
6 | hhtpStatusCode | string | Sim | Status http do Response. Nesse caso, como o código é 400, será BadRequest |
Mensagens possíveis em ‘message’ para 400 Bad Request
| Menssagem | Motivo da mensagem |
---|---|---|
1 | "Número da Conta Bancária deve ser informado para a busca de Conta Detalhada." | Campo ‘numeroConta’ não foi informado no payload de requisição ou foi informado como vazio. |
2 | "Dígito da Conta Bancária deve ser informado para a busca de Conta Detalhada." | Campo ‘digitoConta’ não foi informado no payload de requisição ou foi informado como vazio. |
3 | "Conta não encontrada para os dados informados: Número da Conta: {NumeroConta} / Dígito da Conta: {DigitoConta} / Agência: {Agencia} / Código Banco: {CodigoBanco}." | A conta bancária não foi encontrada para o conjunto de dados informado. Pode ser que um dos dados informados esteja errado ou não tenha sido informado da maneira correta. |
4 | "Pessoa não encontrada para o documento informado: {Documento}." | Não foi encontrada uma pessoa física que tenha uma conta na TARGET para o CPF informado. |
5 | "Conta em questão não pertence ao Documento informado | Conta bancária e Pessoa Física foram encontradas com sucesso, porém a conta não pertence à pessoa. |
Exemplo de Response 400 BadRequest
{
"type": "Warning",
"message": "Conta em questão não pertence ao Documento informado.",
"validations": null,
"exceptionType": "Validacao",
"httpStatusCode": "BadRequest"
}
Response para 500 Internal Server Error
Campo | Tipo | Obrigatório | Descrição | |
---|---|---|---|---|
1 | Response | |||
2 | type | string | Sim | Tipo do erro ocorrido. |
3 | message | string | Sim | Mensagem descritiva do(a) erro/exceção ocorrido(a). |
4 | validations | string | Sim | Validações gerais. Campo não utilizado nesse cenário. |
5 | exceptionType | decimal | Sim | Tipo da Exceção ocorrida. |
6 | hhtpStatusCode | string | Sim | Status http do Response. Nesse caso, como o código é 500, será InternalServerError |
Exemplo de Response 500 Internal Server Error