Listar Saques Recorrentes

Utilize este endpoint para listar saques recorrentes com filtros.

Ambientes Disponíveis

Produção

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

Endpoint

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

Query Params

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

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

ℹ️ 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
startDate	string	Não	Data inicial do filtro (createdAt)	Deve ser ISO date string com horário
endDate	string	Não	Data final do filtro (createdAt)	Deve ser ISO date string com horário
status	string[] (enum) - ACTIVE, CANCELLED	Não	Lista de status para filtrar	Deve ser um array não vazio e sem duplicados
pixKey	string	Não	Chave PIX de destino
description	string	Não	Descrição do saque recorrente

Exemplo de Requisição

cURL

curl --request GET \
--url https://api.gateway.com.br/core/recurring-withdrawal?status=ACTIVE \
--header 'Authorization: Bearer seu-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 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 saques recorrentes

Campos do item em data

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único do saque recorrente
pixKey	object	Sim	Chave PIX de destino (ver Sub-Objeto PixKeyVo)
amount	number	Sim	Valor de cada saque (inteiro em centavos)
status	string (enum) - ACTIVE, CANCELLED	Sim	Status do saque recorrente
frequencyType	string (enum) - REPEAT_EVERY, FIXED_DAY	Sim	Tipo de frequência
frequencyUnit	string (enum) - DAYS, MONTHS	Sim	Unidade da frequência
frequencyValue	number	Sim	Intervalo (para REPEAT_EVERY) ou dia do mês (para FIXED_DAY)
duration	number	Sim	Quantidade de execuções agendadas
description	string	Sim	Descrição do saque recorrente
lastScheduledDate	string (ISO)	Sim	Data do último agendamento gerado
createdAt	string (ISO)	Sim	Data de criação
updatedAt	string (ISO)	Sim	Data da última atualização

Sub-Objetos

PixKeyVo

Campo	Tipo	Obrigatório	Descrição
key	string	Sim	Chave PIX
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Sim	Tipo da chave PIX

Exemplo de Resposta

Dados mascarados

Valores sensíveis podem estar mascarados com ***.

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

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
422	Dados inválidos ou faltando	Verifique o formato dos dados
500	Erro interno	Contate o suporte