Listar Programaciones

Utilice este endpoint para listar las programaciones (schedulings) generadas por un retiro recurrente.

Cada retiro recurrente genera una programación por ejecución prevista, de acuerdo con la frecuencia y la duración indicadas al crearlo.

Entornos Disponibles

Producción

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

Endpoint

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

Path Params

Nombre	Tipo	Obligatorio	Descripción	Validaciones
id	string (UUID)	Sí	Identificador del retiro recurrente	Debe ser un UUID válido

Query Params

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

Ejemplo de Solicitud

cURL

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

JavaScript

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

Campos del elemento en data

Campo	Tipo	Obligatorio	Descripción
id	string (UUID)	Sí	Identificador único de la programación
status	string (enum) - SCHEDULED, PROCESSED, FAILED, CANCELED	Sí	SCHEDULED: esperando la fecha prevista de ejecución PROCESSED: retiro procesado con éxito FAILED: error al procesar el retiro CANCELED: programación cancelada (por ejemplo, el retiro recurrente fue cancelado)
amount	number	Sí	Monto del retiro (entero, en centavos)
description	string	Sí	Descripción del retiro
scheduledDate	string (ISO)	Sí	Fecha prevista de ejecución

Ejemplo de Respuesta

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

Errores Posibles

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