Skip to main content
Consulta de agendamento de lançamentos futuros para uma conta bancária específica.
curl --request GET \
  --url https://api.ext.dbs.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",
    "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>",
    "autorizacoes": [
      {
        "nomeAutorizador": "<string>",
        "dtAprovacao": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Through this endpoint, the partner can view an upcoming transfer or payment release.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
BancoNumero
string

Número identificador da Instituição Financeira.

​
ContaDto.Agencia
string

Número da agência bancária.*

Observações:

  • O número da agência pode ter no máximo 4 caracteres.
​
ContaDto.AgenciaDigito
string

Dígito verificador da agência bancária.

Observações:

  • O dígito verificador da agência bancária pode ter no máximo 1 caracter.
​
ContaDto.Conta
string

Número da conta bancária.

Observações:

  • O número da conta bancária pode ter no máximo 12 caracteres.
  • Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
  • Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
  • Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.
​
ContaDto.ContaDigito
string

Dígito verificador do número da conta bancária.

Observações:

  • O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.
​
ContaDto.ContaPgto
string

Número da conta bancária seguido do dígito verificador.

Observações:

  • O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.
​
ContaDto.TipoConta
enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Available options:
1,
2,
3,
4
​
ContaDto.ModeloConta
enum<integer>

Modelo da conta.*

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

Observações:

  • Pelo menos um dos campos 'data de início da consulta' (dataInicioAgendamento) ou 'data final da consulta' (dataFimAgendamento) deve ser informado.
  • Quando ambos os campos forem informados, a 'data de início da consulta' (dataInicioAgendamento) deverá ser anterior à 'data final da consulta' (dataFimAgendamento).
​
DataFimAgendamento
string<date-time>

Data final da consulta dos agendamentos.

Observação:

  • Quando a 'data inicial da consulta' (dataInicioAgendamento) for informada a 'data final da consulta' (dataFimAgendamento) deverá ser posterior a ela.

Response

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>
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,
1014,
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<double>

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.