25 - Consulta de Lançamento Futuro

Scopes:

api.ext api.lancsfut

Por meio deste endpoint, o parceiro pode visualizar um lançamento futuro de transferência ou pagamento.

Tabelas de Enums:

Show Enums do campo origemTransacao

Enum	Descrição
0	Movimento manual
1	Transferência interna
2	Envio TED
3	Pagamento de Boleto
4	Envio Transferencia CR
5	Envio PIX
6	Pagamento Titulo Concessionaria
7	Compra Cartão
8	Saque Cartão
9	Solicitação Cartão
10	Cobrança Recorrente
501	Recebimento de Transferência
502	Recebimento TED
503	Recebimento Boleto
504	Recebimento Transferência CR
505	Recebimento de PIX
506	Recebimento de Crédito Operacional
507	Recebimento de Boleto Unificado
1001	Devolução Transferencia
1002	Revolução TED
1003	Devolução Título
1004	Devolução Transferência CR
1005	Estorno PIX
1006	Devolução PIX
1007	Devolução Pagamento Título Concessionária
1008	Devolução Compra Cartão
1009	Devolução Saque Cartão
1010	Devolução LDL
1011	Estorno Devolução LDL
1012	Devolução LTR
1013	Estorno Devolução LTR
1200	Boleto Comunicação
1501	Registro Boleto
1502	Alteração Boleto
1503	Cancelamento Boleto
1701	Cessão Boleto
1601	Protesto Boleto
2001	CNAB_REG
2002	CNAB_PGT
2003	CNAB_ALT
2004	CNAB_CAN
2010	CNAB Remessa
2012	CNAB Retorno
2501	Split
3001	Serviço
3002	Bloqueio Serviço
4001	Safe
4501	Previa Boleto Credito
5001	Rejeição Envio PIX
5002	Rejeição Estorno PIX
5003	Rejeição Estorno PIX
5004	Rejeição Devolução PIX

Show Enums do campo situacao

Enum	Descrição
10	Validar
11	Validando
12	Validado
21	Verificando Aprovacao
22	Em Aprovacao
23	Aprovado
24	Reprovado
31	Verificando Agendamento
32	Agendado
33	Executar
34	Cancelado
35	Registrado Agendamento Recorrente Pix
41	Executando
42	Executado
50	Reprocessar
51	Reprocessar Validacao

Show Enums do campo situacaoAprovacao

Enum	Descrição
0	Pendente
1	Aprovado
2	Reprovado
3	Cancelada

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Query Parameters

BancoNumero · string

Número identificador da Instituição Financeira. Ex: 001 para Banco do Brasil, etc...

ContaDto.Agencia · string

Número da Agência Bancária.

ContaDto.AgenciaDigito · string

Dígito verificador da Agência Bancária.

ContaDto.Conta · string

Número da Conta Bancária.

ContaDto.ContaDigito · string

Dígito verificador do número da Conta Bancária.

ContaDto.ContaPgto · string

Número da Conta Bancária seguido do dígito verificador.

ContaDto.TipoConta · enum<integer>

1 = CACC<br>2 = SVGS<br>3 = TRAN<br>4 = SLRY 1 = CACC; 2 = SVGS; 3 = TRAN; 4 = SLRY

Available options:

1,

2,

3,

4

ContaDto.ModeloConta · enum<integer>

1 = Movimento<br>2 = Escrow<br>3 = Vinculada 1 = Movimento; 2 = Escrow; 3 = Vinculada

Available options:

1,

2,

3

ListarApenasAgendamentosPendentes · boolean

Indica se a Consulta irá listar apenas Agendamentos pendentes de execução.

ListarAutorizacoes · boolean

Indica se a consulta incluirá, além das Informações dos Agendamentos, as Autorizações relacionadas.

DataInicioAgendamento · string<date-time>

Data de Início da Consulta dos Agendamentos.

DataFimAgendamento · string<date-time>

Data Final da Consulta dos Agendamentos.

Response

200 - application/json

Success

codigoConta · string<uuid>

Código UUID identificador da Conta Bancária de destino.

codigoTicket · string<uuid>

codigo · string<uuid>

Código UUID identificador do registro de Agendamento.

parceiro · string | null

Nome do Parceiro.

contaPgto · string | null

Combinação de número da Conta Bancária de Origem + Número da Agência de Origem. Sem espaços ou caracteres especiais.

descricao · string | null

Descrição/Nome da Conta Bancária de Origem.

dtInclusao · string<date-time>

Data de inclusão do registro.

origemTransacao · enum<integer>

0 = MovimentoManual; 1 = Transferência Interna; 2 = Envio TED; 3 = Pagamento de Boleto; 4 = EnvioTransfCR; 5 = Pix; 6 = PagamentoTituloConcessionaria; 7 = CompraCartao; 8 = SaqueCartao; 9 = SolicitacaoCartao; 10 = Cobrança Recorrente; 501 = Recebimento de Transfêrencia; 502 = Recebimento de TED; 503 = Recebimento de Boleto; 504 = RecebTransfCR; 505 = Recebimento de PIX; 506 = Recebimento de Crédito Operacional; 507 = Recebimento de Boleto Unificado; 1001 = DevolucaoTransf; 1002 = Devolução TED; 1003 = DevolucaoTitulo; 1004 = DevolucaoTransfCR; 1005 = EstornoPix; 1006 = Devolução Pix; 1007 = DevolucaoPagamentoTituloConcessionaria; 1008 = DevolucaoCompraCartao; 1009 = DevolucaoSaqueCartao; 1010 = DevolucaoLDL; 1011 = EstornoDevolucaoLDL; 1012 = DevolucaoLTR; 1013 = EstornoDevolucaoLTR; 1200 = BoletoComunicacao; 1501 = RegistroBoleto; 1502 = AlteracaoBoleto; 1503 = CancelamentoBoleto; 1601 = ProtestoBoleto; 1701 = CessaoBoleto; 2001 = CNAB_REG; 2002 = CNAB_PGT; 2003 = CNAB_ALT; 2004 = CNAB_CAN; 2010 = CNABRemessa; 2012 = CNABRetorno; 2501 = Split; 3001 = Servico; 3002 = BloqueioServico; 4001 = Safe; 4501 = PreviaBoletoCredito; 5001 = RejeicaoEnvioPix; 5002 = RejeicaoRecebePix; 5003 = RejeicaoEstornoPix; 5004 = RejeicaoDevolucaoPix

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

501,

502,

503,

504,

505,

506,

507,

1001,

1002,

1003,

1004,

1005,

1006,

1007,

1008,

1009,

1010,

1011,

1012,

1013,

1200,

1501,

1502,

1503,

1601,

1701,

2001,

2002,

2003,

2004,

2010,

2012,

2501,

3001,

3002,

4001,

4501,

5001,

5002,

5003,

5004

dtAgendamento · string<date-time>

Data e hora da efetivação do Agendamento da Transação Financeira.

valor · number

Valor total da Transação agendada.

nome · string | null

Nome completo do Agendador.

documentoFederal · string | null

CPF ou CNPJ do Agendador, à depender da natureza do mesmo.

numeroBanco · string | null

Código da Instituição Financeira de destino.

descricaoBanco · string | null

Nome da Instituição Financeira de destino.

agencia · string | null

Número da Agência de destino.

agenciaDigito · string | null

Dígito verificador da Agência de destino.

contaDestino · string | null

Númmero da Conta Bancária de destino.

contaDigitoDestino · string | null

Dígito verificador da Conta Bancária de destino.

contaPgtoDestino · string | null

Combinação de número da Conta Bancária de destino + Número da Agência de destino. Sem espaços ou caracteres especiais.

chavePix · string | null

Chave PIX da transferência. Presente somente em registros cujo a Origem da Transação seja Envio de Pix.

codigoBarras · string | null

Código de Barras do Boleto. Presente somente em registros cujo a Origem da Transação seja Pagamento de Boleto.

linhaDigitavel · string | null

Linha Digitável do Boleto. Presente somente em registros cujo a Origem da Transação seja Pagamento de Boleto.

situacao · enum<integer>

10 = Validar; 11 = Validando; 12 = Validado; 21 = VerificandoAprovacao; 22 = EmAprovacao; 23 = Aprovado; 24 = Reprovado; 31 = VerificandoAgendamento; 32 = Agendado; 33 = Executar; 34 = Cancelado; 35 = Registrado em Agendamento Recorrente Pix; 41 = Executando; 42 = Executado; 50 = Reprocessar; 51 = Reprocessar Validação

Available options:

10,

11,

12,

21,

22,

23,

24,

31,

32,

33,

34,

35,

41,

42,

50,

51

autorizacoes · object[] | null

Lista de Autorizações da Transação associadas ao Agendamento.

Show child attributes