curl --request GET \
  --url https://api.bmpdigital.moneyp.dev.br/api/LancamentosFuturos \
  --header 'Authorization: <api-key>'
[
  {
    "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoTicket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parceiro": "<string>",
    "contaPgto": "<string>",
    "descricao": "<string>",
    "dtInclusao": "2023-11-07T05:31:56Z",
    "origemTransacao": 0,
    "dtAgendamento": "2023-11-07T05:31:56Z",
    "valor": 123,
    "nome": "<string>",
    "documentoFederal": "<string>",
    "numeroBanco": "<string>",
    "descricaoBanco": "<string>",
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "contaDestino": "<string>",
    "contaDigitoDestino": "<string>",
    "contaPgtoDestino": "<string>",
    "chavePix": "<string>",
    "codigoBarras": "<string>",
    "linhaDigitavel": "<string>",
    "situacao": 10,
    "autorizacoes": [
      {
        "nomeAutorizador": "<string>",
        "situacaoAprovacao": 0,
        "dtAprovacao": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Through this endpoint, partners can view a future transfer or payment transaction.

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>
Available options:
1,
2,
3,
4
ContaDto.ModeloConta
enum<integer>
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

Data de Início da Consulta dos Agendamentos.

DataFimAgendamento
string

Data Final da Consulta dos Agendamentos.

Response

200 - application/json
Success
codigoConta
string

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

codigoTicket
string
codigo
string

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

Data de inclusão do registro.

origemTransacao
enum<integer>
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

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>
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.