Skip to main content
POST
Cancel a TED payment
Only a REQUESTED TED can be cancelled; it becomes CANCELLED and nothing is sent. Cancelling it again answers 409. Send no body. You need the same permission as to pay from the wallet: on the organization’s main wallet, be an admin of the organization or of the realm; on another wallet, be one of those admins or have it shared with you as OWNER or USER.

Headers

x-environment
enum<string>

Environment of the TED: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; 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.

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 the TED is sent from (24 hexadecimal characters), or default for the organization's main wallet.

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

ID of the TED payment — its _id (24 hexadecimal characters).

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

Response

No Content. The operation succeeded and the response has no body.