List Reserves

Use this endpoint to list reserves with filters.

Available Environments

Production

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

Endpoint

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

Query Params

ℹ️ 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
status	string[] (enum) - PENDING, RELEASED	No	List of statuses to filter by	Must be a non-empty array with no duplicates

Request Example

cURL

curl --request GET \
--url https://api.gateway.com.br/core/reserve?status=PENDING \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({});
params.append('status', 'PENDING');

const response = await fetch(`https://api.gateway.com.br/core/reserve?${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 reserves

Fields of the item in data

Field	Type	Required	Description
id	string (UUID)	Yes	Unique identifier
transactionId	string (UUID)	Yes	Unique identifier of the transaction
status	string (enum) - PENDING, RELEASED	Yes	PENDING: reserve created, awaiting release RELEASED: reserve released
amount	number	Yes	Reserve amount (integer, in cents)
scheduleDate	string	No	Date of the automatic release
releaseDate	string	No	Date of the release
createdAt	string (ISO)	Yes	Creation date

Response Example

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "status": "PENDING",
      "amount": 10000,
      "scheduleDate": "2026-03-06T12:49:04.681Z",
      "releaseDate": null,
      "createdAt": "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
500	Internal error	Contact support