List Reports

Use this endpoint to list reports with filters.

Available Environments

Production

https://api.gateway.com.br/core

Endpoint

• Method: GET
• Endpoint: /report
• Authentication: Bearer token

Query Params

ℹ️ Dates in ISO

The startDate and endDate fields must be sent as an ISO date string with time.

Example:

• 2026-03-06T12:00:00.000Z

ℹ️ Snapshot pagination

The snapshot is not a pointer to the "next page": it is a fixed identifier of the pagination session, used together with page (which is still sent and incremented normally) to keep the results consistent even if new records are created while you navigate.

Take the snapshot value from the first response (sent without a snapshot on the first request) and resend that same value, unchanged, on the requests for the following pages, along with the same filters and the same perPage used originally. If any of those values changes while an old snapshot is resent, the API returns an error.

Name	Type	Required	Description	Validations
snapshot	string	No	Identifier of the pagination session (received in the snapshot field of the first response); resend it unchanged along with page on the following pages	Must match the same filters and the same perPage of the original request
startDate	string	No	Start date of the filter	Must be an ISO date string with time
endDate	string	No	End date of the filter	Must be an ISO date string with time
status	string[] (enum) - PENDING, PROCESSING, FAILED, PROCESSED	No	List of statuses	Must be a non-empty array with no duplicates
type	string[] (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES	No	List of report types	Must be a non-empty array with no duplicates
origin	string[] (enum) - ADMIN, USER	No	Report origin	Must be a non-empty array with no duplicates
id	string (UUID v4)	No	Report identifier	Must be a valid UUID v4
userName	string	No	User name	At most 255 characters
userEmail	string	No	User e-mail	Must be a valid e-mail

Request Example

cURL

curl --request GET \
--url "https://api.gateway.com.br/core/report?status=PROCESSED&type=TRANSACTION&origin=USER" \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({
  status: 'PROCESSED',
  type: 'TRANSACTION',
  origin: 'USER'
});

const response = await fetch(`https://api.gateway.com.br/core/report?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

Success Response

Field	Type	Required	Description
totalPages	number	Yes	Total pages
currentPage	number	Yes	Current page
perPage	number	Yes	Items per page
snapshot	string	No	Identifier of the pagination session; resend it unchanged on the following pages
data	array	Yes	List of reports (see Sub-Object ListItem)

Sub-Objects

ListItem

Field	Type	Required	Description
id	string	Yes	Report identifier
status	string (enum)	Yes	Report status (PENDING, PROCESSING, FAILED, PROCESSED)
type	string (enum)	Yes	Report type (TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES)
user	object	Yes	User data (see Sub-Object User)
origin	string (enum)	No	Report origin (ADMIN, USER)
filters	object	Yes	Filters used in the report (see Sub-Object Filters)
file	object	No	Report file (see Sub-Object File)
expirationDate	string (ISO)	No	File expiration date
errorMessage	string	No	Error message
createdAt	string (ISO)	Yes	Creation date
updatedAt	string (ISO)	Yes	Last update date

User

Field	Type	Required	Description
id	string	Yes	User identifier
name	string	Yes	User name
email	string	Yes	User e-mail

Filters

Field	Type	Required	Description
startDate	string	Yes	Start date of the filter
endDate	string	Yes	End date of the filter
storeId	string (UUID v4)	No	Store identifier
userId	string (UUID v4)	No	User identifier
status	string[]	No	List of statuses applied
paymentMethod	string[]	No	Payment methods
acquirer	string[]	No	Acquirers of the report

File

Field	Type	Required	Description
key	string	Yes	File key
isPrivate	boolean	Yes	Whether the file is private
url	string	Yes	URL to access the file

Response Example

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "status": "PROCESSED",
      "type": "TRANSACTION",
      "user": {
        "id": "553e8400-e29b-41d4-a716-436251480111",
        "name": "Loja Exemplo",
        "email": "contato@lojaexemplo.com"
      },
      "origin": "USER",
      "filters": {
        "startDate": "2026-03-06T00:00:00.000Z",
        "endDate": "2026-03-06T23:59:59.999Z",
        "status": ["PAID"],
        "paymentMethod": ["PIX"]
      },
      "file": {
        "key": "report-2026-03-06-553e8400-e29b-41d4-a716-436251480000-CSV",
        "isPrivate": true,
        "url": "signed-url"
      },
      "expirationDate": null,
      "errorMessage": null,
      "createdAt": "2026-03-06T12:49:04.681Z",
      "updatedAt": "2026-03-06T12:49:04.681Z"
    }
  ]
}

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your credentials
403	No permission/authorization	Contact support
422	Invalid or missing data	Check the format of the data
422	Validations	Contact support
500	Internal error	Contact support