Listar Agendamentos

Utilize este endpoint para listar os agendamentos (schedulings) gerados por um saque recorrente.

Cada saque recorrente gera um agendamento por execução prevista, de acordo com a frequência e a duração informadas na criação.

Ambientes Disponíveis

Produção

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

Endpoint

• Método: GET
• Endpoint: /recurring-withdrawal/{id}/schedulings
• Autenticação: Bearer token

Path Params

Nome	Tipo	Obrigatório	Descrição	Validações
id	string (UUID)	Sim	Identificador do saque recorrente	Deve ser UUID válido

Query Params

ℹ️ Paginação por snapshot

O snapshot não é um ponteiro para a "próxima página": é um identificador fixo da sessão de paginação, usado junto com page (que continua sendo enviado e incrementado normalmente) para manter os resultados consistentes mesmo se novos registros forem criados durante a navegação.

Pegue o valor de snapshot na primeira resposta (sem enviar snapshot no primeiro request) e reenvie esse mesmo valor, sem alterá-lo, nas requisições das páginas seguintes, junto com os mesmos filtros e o mesmo perPage usados originalmente. Se algum desses valores mudar enquanto um snapshot antigo é reenviado, a API retorna erro.

Nome	Tipo	Obrigatório	Descrição	Validações
snapshot	string	Não	Identificador da sessão de paginação (recebido no campo snapshot da primeira resposta); reenvie sem alterar junto com page nas páginas seguintes	Deve corresponder aos mesmos filtros e ao mesmo perPage da requisição original

Exemplo de Requisição

cURL

curl --request GET \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/schedulings \
--header 'Authorization: Bearer seu-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 seu-token-jwt'
  }
});
const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
totalPages	number	Sim	Total de páginas
currentPage	number	Sim	Página atual
perPage	number	Sim	Itens por página
snapshot	string	Não	Identificador da sessão de paginação; reenvie sem alterações nas páginas seguintes
data	array	Sim	Lista de agendamentos

Campos do item em data

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único do agendamento
status	string (enum) - SCHEDULED, PROCESSED, FAILED, CANCELED	Sim	SCHEDULED: Aguardando a data prevista para execução PROCESSED: Saque processado com sucesso FAILED: Erro ao processar o saque CANCELED: Agendamento cancelado (ex.: saque recorrente cancelado)
amount	number	Sim	Valor do saque (inteiro em centavos)
description	string	Sim	Descrição do saque
scheduledDate	string (ISO)	Sim	Data prevista para execução

Exemplo de Resposta

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

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
404	Registro não encontrado	Verifique o id informado
422	Dados inválidos ou faltando	Verifique o formato dos dados
500	Erro interno	Contate o suporte