Consultar Retiro Recurrente

Utilice este endpoint para consultar un retiro recurrente específico por su id.

Entornos Disponibles

Producción

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

Endpoint

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

Ejemplo de Solicitud

cURL

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

Respuesta Exitosa

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í	ACTIVE: retiro recurrente activo CANCELLED: retiro recurrente cancelado
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
totalAmountWithdrawn	number	No	Suma de los montos ya retirados en las programaciones procesadas (entero, en centavos)

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

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

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