Conta Corrente
Disponibilizamos para os nossos clientes funcionalidades que permitem a rastreabilidade e a governança dos valores movimentados na conta corrente.
Obtenção de saldo da conta
Nesta funcionalidade, são retornadas as posições atualizadas de valores disponíveis e bloqueados na conta corrente do cliente.
Solicitamos os campos:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| dataReferencia | Data de referência para buscar saldo | date-time | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| Valor | Valor do saldo disponível para uso na conta corrente | number <double> | Não |
| valorBloqueado | Valor do saldo bloqueado que não estará disponível para uso | number <double> | Não |
Obtenção de Extrato da Conta
Por meio desta funcionalidade, entregamos informações detalhadas de movimentações financeiras em conta, tais como: data contábil, valor, descrição, tipo de movimento (C – crédito, D – débito), protocolo, código do histórico e descrição, entre outros.
Extrato da conta
Com intuito de fornecer uma melhor experiência, será possível consultar online as movimentações de forma analítica e/ou sintética, o que facilitará a conciliação financeira.
- Analítica – Informações detalhadas de transações e valores;
- Sintética – Agrupamento de informações de transações e valores
Extrato analítico
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| Data inicial | Data inicial do período do extrato, incluindo horas e minutos | date-time | Sim |
| Data final | Data final do período do extrato, incluindo horas e minutos | date-time | Sim |
| Natureza da Operação | Tipo de movimento, que poderá ser: Crédito ou Débito | string | Não |
| Históricos de movimento | Informa um ou mais históricos conforme tabela de código de históricos de movimento. | array | Não |
| Ordenação | Crescente ou decrescente | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| Movimentações | Disponibilizamos a data/hora contábil da operação (em GMT-3), natureza do lançamento (C – crédito/D – débito), código do histórico e descrição, valor, protocolo, dados da contraparte, dados complementares. | array | Sim |
Extrato sintético
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| Data inicial | Data inicial do período do extrato, incluindo horas e minutos | date-time | Sim |
| Data final | Data final do período do extrato, incluindo horas e minutos | date-time | Sim |
| Natureza da Operação | Tipo de movimento, que poderá ser: Crédito ou Débito | string | Não |
| Históricos de movimento | Informa um ou mais históricos conforme tabela de código de históricos de movimento. | array | Não |
| Ordenação | Crescente ou decrescente | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| Movimentações | Disponibilizamos a data/hora contábil da operação (em GMT-3), natureza do lançamento (C – crédito/D – débito), código do histórico e descrição, valor, protocolo, dados da contraparte, dados complementares. | array | Sim |
Códigos de históricos de movimento
Abaixo estão citadas algumas categorias, com códigos de históricos, respectivas descrições e natureza.
Depósito
| Código | Descrição | Natureza |
|---|---|---|
| 938 | DEPÓSITO ATRAVÉS DE BOLETO / DEPÓSITO ATRAVÉS DE BOLETO | D |
Investimentos
| Código | Descrição | Natureza |
|---|---|---|
| 352 | APLICAÇÃO FINANCEIRA / APLICAÇÃO | D |
| 1573 | REMUNERAÇÃO APLICAÇÃO AUTOMÁTICA / REMUNERAÇÃO APLICAÇÃO AUT | C |
Operações de Crédito
| Código | Descrição | Natureza |
|---|---|---|
| 320 | DÉBITO PARCELA EMPREST. / DÉBITO PARCELA EMPRÉSTIMO | D |
| 19 | LÍQ.OPER. EMPRÉSTIMO / LÍQUIDO OPERAÇÃO EMPRÉST | C |
| 1007 | CRÉDITO LIQUIDAÇÃO CENTRALIZADA-EMISSOR / CR.LIQ.CENTR.- EMISSOR | C |
Pagamento
| Código | Descrição | Natureza |
|---|---|---|
| 380 | PAGAMENTO OPER. EMPRÉSTIMO/ PAGAMENTO OPER EMPRÉSTIMO | D |
| 383 | PAGAMENTOS DE TRIBUTOS-CL / PAGAMENTO TRIBUTOS | D |
| 782 | PGTO COBRANÇA INTERN.BANK. / PAGAMENTO BOLETO | D |
| 784 | PGTO CONCES.PUB.INT.BANK. / PGTO CONCESS/TRIBUTO | D |
| 916 | DEB.SERV.DE PAGTO TED / DEB SERV DE TRANSF EM LOT | D |
| 1026 | COMPRA À VISTA MASTERCARD NAC / COMPRA À VISTA MASTER NAC | D |
| 17 | LÍQUIDO DE COBRANÇA – PGTO/DEPÓSITO BOLETOS | C |
| 20 | LÍQUIDO COBRANÇA VINCULADA / LÍQUIDO COBRANÇA VINCULAD | C |
| 204 | RECEB.CARTÃO CRÉDITO / RECEBIMENT CARTÃO CRÉDITO | C |
| 208 | RECEB.CARTÃO ANTECIPAÇÃO / RECEB.CARTÃO ANTECIPAÇÃO | C |
Pix
| Código | Descrição | Natureza |
|---|---|---|
| 1501 | Débito Pix / PIX ENVIADO | D |
| 1505 | Débito Devolução Pix / DEVOLUÇÃO ENVIADA PIX | D |
| 1507 | Débito PIX Transf. Interna / PIX INTERNO ENVIADO | D |
| 1090 | CRÉDITO PIX MANUAL / PIX RECEBIDO MANUAL | C |
| 1091 | CRÉDITO PIX CHAVE / PIX RECEBIDO CHAVE | C |
| 1504 | Crédito Devolução Pix / DEVOLUÇÃO RECEBIDA PIX | C |
| 1506 | Crédito Pix Transf. Interna / PIX INTERNO RECEBIDO | C |
| 1526 | Crédito Pix QR Code/ Crédito Pix QR Code | C |
Saque
| Código | Descrição | Natureza |
|---|---|---|
| 924 | SAQUE CARTAO DÉBITO NAC / SAQUE BANCO 24H | D |
| 1052 | SAQUE DIGITAL / SAQUE BANCO 24H | D |
Tarifas
| Código | Descrição | Natureza |
|---|---|---|
| 340 | TARIFA ENTRADA TÍTULO / TARIFA ENTRADA TÍTULO | D |
| 361 | TARIFA MANUT MENSAL C/C / TARIFA MANUT MENSAL CONTA | D |
| 555 | TARIFA TED BS2.EMP / TARIFA TED BS2.EMP | D |
| 561 | TARIFA.ENTRADA.TIT.BS2.EMP / TAR.ENTRADA.TIT.BS2.EMP | D |
| 563 | TAR.BAIXA.TIT.FINAN.BS2.EMP / TAR.BAIXA.TIT.FINAN.BS2.EMP | D |
| 565 | TAR.BAIX.TIT.S/.FINAN.BS2.EMP / TAR.BAX.TIT.S/FIN.BS2.EMP | D |
| 653 | TARIFA OPERAÇÃO / TARIFA DE OPERAÇÃO | D |
| 1056 | TARIFA OPERAÇÕES PIX / TARIFA OPERAÇÕES PIX | D |
| 1120 | TARIFA T.A.C. / TARIFA T.A.C. | D |
| 1216 | TARIFA COBRANÇA ARQUIVO CNAB / TAR. COBRAN. ARQ. CNAB | D |
| 1222 | TARIFA CRÉDITO PIX / TARIFA CRÉDITO PIX | D |
| 1524 | TARIFAS PIX REMESSA / TAR TRANSF EM LOTE | D |
| 1530 | TARIFA DE MEDIÇÃO DE OBRA / TARIFA DE MEDIÇÃO DE OBRA | D |
Transferência
| Código | Descrição | Natureza |
|---|---|---|
| 373 | TED REMETIDA OUTRA TITULARIDADE MANUAL / TED ENV OUTRA TIT MANUAL | D |
| 778 | TED REMETIDA OUTRA TITULARIDADE IB / TED ENVIADA OUTRA TIT IB | D |
| 779 | TED REMETIDA MESMA TITULARIDADE IB / TED ENVIADA MESMA TIT IB | D |
| 780 | TRANSF.ENT.CTAS INTERN. BANKING / TRANSF ENTRE CONTAS BS2 | D |
| 781 | TRANSF.ENT.CTAS DIF. INTER.BANK. / TRANSF ENTRE CONTAS BS2 | D |
| 829 | TED ENVIADA STR008 / TED ENVIADA STR008 | D |
| 50 | TED C RECEBIDA / RECEBIMENTO TED | C |
| 786 | RECEB.TRANSF.ENT.CONTAS IB / RECEBIMENTO CONTAS BS2 | C |
Outros
| Código | Descrição | Natureza |
|---|---|---|
| 25 | LANÇAMENTO AVISADO A CRÉDITO / CRÉDITO CONFORME AVISO | C |
| 301 | TRANSFERÊNCIA ENTRE CONTAS / TRANSF ENTRE CONTAS BS2 | D |
| 322 | DÉBITO CONFORME AVISO / DÉBITO CONFORME AVISO | D |
| 385 | TRANSF.ENTRE CONTAS – DIFERENTE / TRANSF ENTRE CONTAS BS2 | D |
| 413 | ACOLHIMENTO DEPÓSITO JUDICIAL / ACOLHIMENTO JUDICIAL | D |
Obtenção do extrato da conta (Legado)
No extrato, são retornados os dados detalhados sobre as movimentações financeiras na conta corrente do cliente.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| movimentoInicial | Data inicial do período do extrato bancário. | date-time | Sim |
| movimentoFinal | Data final do período do extrato bancário. O intervalo entre as datas não pode ser superior a 31 dias. | date-time | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| Saldo | Saldos inicial, final e bloqueado | object | Não |
| ChequeEspecial | Apresenta as informações de taxa de juros, valor limite, data de vencimento, IOF, total de juros acumulado, custo efetivo total e quantidade de dias de utilização do cheque especial | object | Não |
| Movimentacoes | Apresenta a data de movimentação, descrição, valor, tipo de movimentação ('D' débito ou 'C' crédito) e a categoria (ver a tabela [Categorias de movimentações]), remetente e favorecido da movimentação | array | Sim |
Obter o extrato da conta (legado)
Categorias de movimentações (extrato legado)
As categorias mapeadas de movimentações financeiras, são:
| Enumeração | Descrição |
|---|---|
| 1 | Pagamento |
| 2 | Transferência |
| 3 | Depósito |
| 4 | Saque |
| 5 | Estorno de Pagamento |
| 6 | Estorno de Transferência |
| 7 | Tarifa |
| 8 | Estorno de Tarifa |
| 9 | Compra Cartão |
| 10 | Crédito PIX |
| 11 | Débito Pix |
| 12 | Débito Devolução Interna Pix |
| 13 | Crédito Restituição Interna Pix |
| 14 | Crédito Devolução Pix |
| 15 | Débito Devolução Pix |
| 16 | Credito Recebimento Interno Pix |
| 17 | Debito Pagamento Interno Pix |
| 18 | Devolução Débito Pix |
| 19 | Devolução Crédito Pix |
| 20 | Tarifa Pix |
| 99 | Outros |
Obtém dados da conta bancária na autenticação
Esta funcionalidade apresenta os dados da conta corrente que está efetuando as requisições a esta API.
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| usuario | Identifica o usuário autenticado na aplicação | string | Sim |
| Empresa | Informar o CNPJ e a razão social | object | Sim |
| Conta | Informar o número da conta e a agência do usuário autenticado | object | Sim |
Updated 8 months ago