Listar Retiros Recurrentes

Utilice este endpoint para listar retiros recurrentes con filtros.

Entornos Disponibles

Producción

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

Endpoint

• Método: GET
• Endpoint: /recurring-withdrawal
• Autenticación: Bearer token

Query Params

ℹ️ Fechas en ISO

Los campos startDate y endDate deben enviarse como ISO date string con hora.

Ejemplo:

• 2026-03-06T12:00:00.000Z

ℹ️ Paginación por snapshot

El snapshot no es un puntero a la "página siguiente": es un identificador fijo de la sesión de paginación, usado junto con page (que se sigue enviando e incrementando normalmente) para mantener los resultados consistentes incluso si se crean nuevos registros durante la navegación.

Tome el valor de snapshot de la primera respuesta (enviada sin snapshot en la primera solicitud) y reenvíe ese mismo valor, sin alterarlo, en las solicitudes de las páginas siguientes, junto con los mismos filtros y el mismo perPage usados originalmente. Si alguno de esos valores cambia mientras se reenvía un snapshot anterior, la API devuelve un error.

Nombre	Tipo	Obligatorio	Descripción	Validaciones
snapshot	string	No	Identificador de la sesión de paginación (recibido en el campo snapshot de la primera respuesta); reenvíelo sin alterar junto con page en las páginas siguientes	Debe corresponder a los mismos filtros y al mismo perPage de la solicitud original
startDate	string	No	Fecha inicial del filtro (createdAt)	Debe ser una ISO date string con hora
endDate	string	No	Fecha final del filtro (createdAt)	Debe ser una ISO date string con hora
status	string[] (enum) - ACTIVE, CANCELLED	No	Lista de estados para filtrar	Debe ser un arreglo no vacío y sin duplicados
pixKey	string	No	Clave PIX de destino
description	string	No	Descripción del retiro recurrente

Ejemplo de Solicitud

cURL

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

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 su-token-jwt'
  }
});
const data = await response.json();

Respuesta Exitosa

Campo	Tipo	Obligatorio	Descripción
totalPages	number	Sí	Total de páginas
currentPage	number	Sí	Página actual
perPage	number	Sí	Elementos por página
snapshot	string	No	Identificador de la sesión de paginación; reenvíelo sin alteraciones en las páginas siguientes
data	array	Sí	Lista de retiros recurrentes

Campos del elemento en data

Campo	Tipo	Obligatorio	Descripción
id	string (UUID)	Sí	Identificador único del retiro recurrente
pixKey	object	Sí	Clave PIX de destino (ver Sub-Objeto PixKeyVo)
amount	number	Sí	Monto de cada retiro (entero, en centavos)
status	string (enum) - ACTIVE, CANCELLED	Sí	Estado del retiro recurrente
frequencyType	string (enum) - REPEAT_EVERY, FIXED_DAY	Sí	Tipo de frecuencia
frequencyUnit	string (enum) - DAYS, MONTHS	Sí	Unidad de la frecuencia
frequencyValue	number	Sí	Intervalo (para REPEAT_EVERY) o día del mes (para FIXED_DAY)
duration	number	Sí	Cantidad de ejecuciones programadas
description	string	Sí	Descripción del retiro recurrente
lastScheduledDate	string (ISO)	Sí	Fecha de la última programación generada
createdAt	string (ISO)	Sí	Fecha de creación
updatedAt	string (ISO)	Sí	Fecha de la última actualización

Sub-Objetos

PixKeyVo

Campo	Tipo	Obligatorio	Descripción
key	string	Sí	Clave PIX
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Sí	Tipo de la clave PIX

Ejemplo de Respuesta

Datos enmascarados

Los valores sensibles pueden estar enmascarados con ***.

{
  "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"
    }
  ]
}

Errores Posibles

Código	Descripción	Solución
401	Credenciales inválidas	Verifique sus credenciales
403	Sin permiso/autorización	Contacte al soporte
422	Datos inválidos o faltantes	Verifique el formato de los datos
500	Error interno	Contacte al soporte