Cancel Recurring Withdrawal

Use this endpoint to cancel an active recurring withdrawal. Every future scheduling (SCHEDULED) is canceled; schedulings already processed are not affected.

ℹ️ Only active withdrawals can be canceled

Only a recurring withdrawal with status ACTIVE can be canceled. Trying to cancel one that is already CANCELLED results in an error.

Available Environments

Production

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

Endpoint

• Method: PUT
• Endpoint: /recurring-withdrawal/{id}/cancel
• 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 PUT \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

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

Success Response

Code	Description
200 OK	Recurring withdrawal canceled successfully

ℹ️ Response body

This endpoint has no response payload.

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	Recurring withdrawal already canceled	Only recurring withdrawals with status ACTIVE can be canceled
500	Internal error	Contact support