List Schedulings

Use this endpoint to list the schedulings (schedulings) generated by a recurring withdrawal.

Each recurring withdrawal generates one scheduling per expected execution, according to the frequency and duration given at creation.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /recurring-withdrawal/{id}/schedulings
• Authentication: Bearer token

Path Params

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

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

Request Example

cURL

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

JavaScript

const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/schedulings', {
  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 schedulings

Fields of the item in data

Field	Type	Required	Description
id	string (UUID)	Yes	Unique identifier of the scheduling
status	string (enum) - SCHEDULED, PROCESSED, FAILED, CANCELED	Yes	SCHEDULED: awaiting the expected execution date PROCESSED: withdrawal processed successfully FAILED: error while processing the withdrawal CANCELED: scheduling canceled (for example, the recurring withdrawal was canceled)
amount	number	Yes	Withdrawal amount (integer, in cents)
description	string	Yes	Description of the withdrawal
scheduledDate	string (ISO)	Yes	Expected execution date

Response Example

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "663e8400-e29b-41d4-a716-446655440001",
      "status": "SCHEDULED",
      "amount": 10000,
      "description": "Repasse mensal para fornecedor",
      "scheduledDate": "2027-02-05T12:00:00.000Z"
    }
  ]
}

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
500	Internal error	Contact support