Skip to main content
Lista arquivos de retorno no padrão CNAB 240 de uma conta específica.
curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/CNAB/240 \
  --header 'Authorization: <api-key>'
[
  {
    "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dtInclusao": "2023-11-07T05:31:56Z",
    "nome": "<string>",
    "nroVersaoLayout": "<string>"
  }
]

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 check for the existence of a return file of the imported files.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
TipoRetorno
enum<integer>

Tipo retorno.

Valores: -1 - Todos 2 - Remessa 3 - Diário

Available options:
0,
1,
-1
​
Conta.Agencia
string

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

Observações:

  • O número da agência pode ter no máximo 4 caracteres.
​
Conta.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.
​
Conta.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.
​
Conta.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.
​
Conta.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.
​
Conta.TipoConta
enum<integer>

Tipo da conta.*

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

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

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Available options:
1,
2,
3
​
DtInicio
string<date-time>

Data de início do período de consulta.

​
DtFim
string<date-time>

Data final do período de consulta.

Response

Success

​
codigo
string<uuid>

Código UUID identificador do registro do arquivo.

​
dtInclusao
string<date-time>

Data de inclusão do registro.

​
nome
string | null

Nome do arquivo.

​
nroVersaoLayout
string | null

Número que identifica a versão do layout CNAB 240 utilizada no arquivo.

​
tipoRetorno
enum<integer>

Situação.

Valores: -1 - Todos 0 - Remessa 1 - Diário

Available options:
0,
1,
-1
​
situacao
enum<integer>

Situação.

Valores: 0 - Pendente 1 - Gerado

Available options:
0,
1