Buscar Saque Recorrente

Utilize este endpoint para buscar um saque recorrente específico pelo id.

Ambientes Disponíveis

Produção

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

Endpoint

• Método: GET
• Endpoint: /recurring-withdrawal/{id}
• 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

Exemplo de Requisição

cURL

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

JavaScript

const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});
const data = await response.json();

Resposta de Sucesso

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	ACTIVE: Saque recorrente ativo CANCELLED: Saque recorrente cancelado
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
totalAmountWithdrawn	number	Não	Soma dos valores já sacados nos agendamentos processados (inteiro em centavos)

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 ***.

{
  "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",
  "totalAmountWithdrawn": 30000
}

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