Create Report

Use this endpoint to create a report request.

Available Environments

Production

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

Endpoint

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

Body Params

Field	Type	Required	Description	Validations
type	string (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES	Yes	Report type	Must be a valid enum; ACCOUNT and ACCOUNT_FINANCIAL_SUMMARY require a user with the manager role
filters	object	Yes	Report filters (see Sub-Object Filters)	Must be a non-empty object

⚠️ ACCOUNT and ACCOUNT_FINANCIAL_SUMMARY require a manager

These two report types can only be requested by a user with the manager role. An account without that role gets a 403 when trying to generate them.

Sub-Objects

Filters

ℹ️ 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

⚠️ Maximum range for WALLET_DAILY_BALANCES

When type is WALLET_DAILY_BALANCES, the range between startDate and endDate cannot exceed 60 days.

Field	Type	Required	Description	Validations
startDate	string	Yes	Start date of the filter	Must be an ISO date string with time
endDate	string	Yes	End date of the filter	Must be an ISO date string with time; if type is WALLET_DAILY_BALANCES, the range between startDate and endDate must be at most 60 days
storeId	string (UUID v4)	No	Store identifier	Optional (send it if you want to filter)
userId	string (UUID v4)	No	User identifier	Optional (send it if you want to filter)
status	string[] (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, PROCESSING, PROCESSED, CANCELED, REJECTED, APPEALED, APPROVED	No	Statuses to filter by	Must be a non-empty array with no duplicates
paymentMethod	string[] (enum) - PIX	No	Payment methods	Must be a non-empty array with no duplicates
acquirer	string[]	No	Acquirers of the report	Must be a non-empty array with no duplicates

Request Example

cURL

curl --request POST \
--url https://api.gateway.com.br/core/report \
--header 'Authorization: Bearer your-jwt-token' \
--header 'Content-Type: application/json' \
--data '{
  "type": "TRANSACTION",
  "filters": {
    "startDate": "2026-03-06T00:00:00.000Z",
    "endDate": "2026-03-06T23:59:59.999Z"
  }
}'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/report', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-jwt-token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'TRANSACTION',
    filters: {
      startDate: '2026-03-06T00:00:00.000Z',
      endDate: '2026-03-06T23:59:59.999Z'
    }
  })
});
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)

Response Example

{
  "id": "553e8400-e29b-41d4-a716-436251480000",
  "status": "PENDING",
  "type": "TRANSACTION"
}

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