Extratos
Contrato 5085d901ceed
API pública para parceiros criarem, manterem e acompanharem garantias locatícias e consultarem seus extratos financeiros. Parceiros respondem às propostas de análise por meio de aceite ou recusa; eles nunca aprovam, reprovam, reabrem ou solicitam mais dados da análise.
- Produção:
https://api.morus.finance/rental-insurance - Sandbox:
https://api-sandbox.morus.finance/rental-insurance
Consultar o saldo atual do extrato
Seção intitulada “Consultar o saldo atual do extrato”GET/v1/statements/balance
Requer ri:statements:read.
Escopo necessário: ri:statements:read
Responses
Seção intitulada “Responses”| Status | Description | Response headers |
|---|---|---|
| 200 | Saldo atual e totais | — |
| 401 | Token Bearer ausente ou inválido | — |
| 403 | O token não contém o escopo necessário | — |
Response body (200)
Seção intitulada “Response body (200)”Content-Type: application/json
{ "balance": 0, "credits": 0, "debits": 0}Exemplo interativoMonte e teste esta requisição
Credenciais
cURL
Response
Response headers
Response body
Listar saldos diários
Seção intitulada “Listar saldos diários”GET/v1/statements/daily
Requer ri:statements:read. O intervalo inclusivo entre as datas deve ser menor que 92 dias.
Escopo necessário: ri:statements:read
Parameters
Seção intitulada “Parameters”| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
startDate |
query | string (date) |
yes | |
endDate |
query | string (date) |
yes |
Responses
Seção intitulada “Responses”| Status | Description | Response headers |
|---|---|---|
| 200 | Saldos diários no período selecionado | — |
| 400 | Parâmetros, corpo, estado ou chave de idempotência inválidos | — |
| 401 | Token Bearer ausente ou inválido | — |
| 403 | O token não contém o escopo necessário | — |
Response body (200)
Seção intitulada “Response body (200)”Content-Type: application/json
[ { "date": "2026-09-15", "openingBalance": 0, "closingBalance": 0, "credits": 0, "debits": 0 }]Exemplo interativoMonte e teste esta requisição
Credenciais
cURL
Response
Response headers
Response body
Listar lançamentos do extrato
Seção intitulada “Listar lançamentos do extrato”GET/v1/statements
Requer ri:statements:read. O intervalo inclusivo entre as datas deve ser menor que 92 dias.
Escopo necessário: ri:statements:read
Parameters
Seção intitulada “Parameters”| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
startDate |
query | string (date) |
yes | |
endDate |
query | string (date) |
yes | |
page |
query | integer |
no | Número da página iniciado em zero. Valores negativos são tratados como zero. |
pageSize |
query | integer |
no | Os valores são limitados ao intervalo de 1 a 200. |
Responses
Seção intitulada “Responses”| Status | Description | Response headers |
|---|---|---|
| 200 | Página de lançamentos do extrato | — |
| 400 | Parâmetros, corpo, estado ou chave de idempotência inválidos | — |
| 401 | Token Bearer ausente ou inválido | — |
| 403 | O token não contém o escopo necessário | — |
Response body (200)
Seção intitulada “Response body (200)”Content-Type: application/json
{ "_embedded": { "statements": [ { "id": 0, "date": "2026-09-15", "description": "string", "amount": 0, "type": "charge_paid" } ] }, "_links": {}, "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 }}Exemplo interativoMonte e teste esta requisição
Credenciais
cURL
Response
Response headers
Response body
