List Recurring Withdrawals

Use this endpoint to list recurring withdrawals with filters.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /recurring-withdrawal
• 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 (createdAt)	Must be an ISO date string with time
endDate	string	No	End date of the filter (createdAt)	Must be an ISO date string with time
status	string[] (enum) - ACTIVE, CANCELLED	No	List of statuses to filter by	Must be a non-empty array with no duplicates
pixKey	string	No	Destination PIX key
description	string	No	Description of the recurring withdrawal

Request Example

cURL

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

JavaScript

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

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

Fields of the item in data

Field	Type	Required	Description
id	string (UUID)	Yes	Unique identifier of the recurring withdrawal
pixKey	object	Yes	Destination PIX key (see Sub-Object PixKeyVo)
amount	number	Yes	Amount of each withdrawal (integer, in cents)
status	string (enum) - ACTIVE, CANCELLED	Yes	Status of the recurring withdrawal
frequencyType	string (enum) - REPEAT_EVERY, FIXED_DAY	Yes	Frequency type
frequencyUnit	string (enum) - DAYS, MONTHS	Yes	Frequency unit
frequencyValue	number	Yes	Interval (for REPEAT_EVERY) or day of the month (for FIXED_DAY)
duration	number	Yes	Number of scheduled executions
description	string	Yes	Description of the recurring withdrawal
lastScheduledDate	string (ISO)	Yes	Date of the last scheduling generated
createdAt	string (ISO)	Yes	Creation date
updatedAt	string (ISO)	Yes	Last update date

Sub-Objects

PixKeyVo

Field	Type	Required	Description
key	string	Yes	PIX key
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Yes	PIX key type

Response Example

Masked data

Sensitive values may be masked with ***.

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "pixKey": {
        "key": "12345678910",
        "type": "CPF"
      },
      "amount": 10000,
      "status": "ACTIVE",
      "frequencyType": "FIXED_DAY",
      "frequencyUnit": "MONTHS",
      "frequencyValue": 5,
      "duration": 12,
      "description": "Repasse mensal para fornecedor",
      "lastScheduledDate": "2027-02-05T12:00:00.000Z",
      "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
500	Internal error	Contact support