Pular para o conteúdo principal
GET
/
api
/
Conta
/
Extrato
cURL
curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Conta/Extrato \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "dtExtrato": "2023-11-07T05:31:56Z",
  "movimentos": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dtMovimento": "2023-11-07T05:31:56Z",
      "dtMovimentoUtc": "2023-11-07T05:31:56Z",
      "descricaoOperacao": "<string>",
      "tipoLancamento": "<string>",
      "vlrMovimento": 123,
      "nsu": 123,
      "codOperacaoCli": "<string>",
      "descCliente": "<string>",
      "documentoFederal": "<string>",
      "nome": "<string>",
      "operador": "<string>",
      "origemTransacao": 0,
      "bancoOrigem": "<string>",
      "agenciaOrigem": "<string>",
      "contaOrigem": "<string>",
      "identificadorOperacao": "<string>",
      "saldoFinalDia": 123,
      "origemMovimento": "<string>",
      "complemento": "<string>",
      "pixQrCode": true,
      "nomeDestinatario": "<string>",
      "documentoDestinatario": "<string>",
      "dadosBancarioDestinatario": "<string>",
      "numeroControle": "<string>",
      "descricao": "<string>",
      "pixChave": "<string>",
      "codigoBarras": "<string>",
      "dadosBancariosOrigem": "<string>",
      "nomeOrigem": "<string>"
    }
  ]
}
Por meio deste endpoint, o parceiro pode solicitar um extrato bancário da movimentação da conta, e assim visualizar o histórico das transações de débito e crédito que ocorreram no período solicitado.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DiaInicial
integer<int32>
​
DiaFinal
integer<int32>
​
Mes
integer<int32>
​
Ano
integer<int32>
​
NumeroBanco
integer<int32>
​
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

Opções disponíveis:
1,
2,
3,
4
​
Conta.ModeloConta
enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Opções disponíveis:
1,
2,
3

Response

Success

​
sucesso
boolean
​
mensagem
string | null
​
dtExtrato
string<date-time>
​
movimentos
object[] | null