Skip to main content
DELETE
Cancel a scheduled payment
A successful answer means the schedule is cancelled. The PIX payment, boleto payment or transfer request it belongs to is marked CANCELLED right after; if that update fails, the answer is still a success and the payment keeps its status — read it back to confirm. Only a schedule still SCHEDULED can be cancelled; cancelling one that is already cancelled succeeds and changes nothing. The answer is an empty object. Organization admins can cancel every wallet’s scheduled payments; other users only those of the wallets shared with them as OWNER or USER.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the wallet belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the wallet that pays the scheduled payment (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$
scheduleId
string<uuid>
required

ID of the schedule, as the scheduled payment returned it.

Format: UUID

Response

Successful response

An empty object: the schedule was cancelled.