Get Recurring Withdrawal

Use this endpoint to get a specific recurring withdrawal by its id.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /recurring-withdrawal/{id}
• Authentication: Bearer token

Path Params

Name	Type	Required	Description	Validations
id	string (UUID)	Yes	Recurring withdrawal identifier	Must be a valid UUID

Request Example

cURL

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

JavaScript

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

Success Response

Field	Type	Required	Description
id	string (UUID)	Yes	Unique identifier of the recurring withdrawal
pixKey	object	Yes	Destination PIX key (see Sub-Object PixKeyVo)
amount	number	Yes	Amount of each withdrawal (integer, in cents)
status	string (enum) - ACTIVE, CANCELLED	Yes	ACTIVE: recurring withdrawal active CANCELLED: recurring withdrawal canceled
frequencyType	string (enum) - REPEAT_EVERY, FIXED_DAY	Yes	Frequency type
frequencyUnit	string (enum) - DAYS, MONTHS	Yes	Frequency unit
frequencyValue	number	Yes	Interval (for REPEAT_EVERY) or day of the month (for FIXED_DAY)
duration	number	Yes	Number of scheduled executions
description	string	Yes	Description of the recurring withdrawal
lastScheduledDate	string (ISO)	Yes	Date of the last scheduling generated
createdAt	string (ISO)	Yes	Creation date
updatedAt	string (ISO)	Yes	Last update date
totalAmountWithdrawn	number	No	Sum of the amounts already withdrawn in the processed schedulings (integer, in cents)

Sub-Objects

PixKeyVo

Field	Type	Required	Description
key	string	Yes	PIX key
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Yes	PIX key type

Response Example

Masked data

Sensitive values may be masked with ***.

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

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your credentials
403	No permission/authorization	Contact support
404	Record not found	Check the id you sent
422	Invalid or missing data	Check the format of the data
500	Internal error	Contact support