Cancel draft transfer

🚧 Beta feature

This feature is currently in beta testing, and the final specification may still change.

Cancels a draft transfer created via this API. Transitions the draft transfer to declined with statusReason.code set to deleted-by-creator.

Only draft transfers created via this API, and still in pending-review, can be cancelled this way. A 422 is returned if the initiator has already started approving it.

In test mode, this always returns a synthetic declined draft. See Create draft transfer for how to simulate approved and declined outcomes.

delete/v2/business-accounts/draft-transfers/{draftTransferId}

Headers

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

testmodeboolean nullable

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

The cancelled (declined) draft transfer object.