Get Report

Use this endpoint to get a report by its id.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /report/{id}
• Authentication: Bearer token

Path Params

Name	Type	Required	Description	Validations
id	string (UUID v4)	Yes	Report identifier	Must be a valid UUID v4

Request Example

cURL

curl --request GET \
--url https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000 \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

Success Response

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

Sub-Objects

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

{
  "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
404	Record not found	Check the id you sent
422	Invalid or missing data	Check the format of the data
422	Validations	Contact support
500	Internal error	Contact support