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 set to "Declined by creator".

Only draft transfers created via this API, and still in awaiting-initiation, 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 full test-mode behavior.

๐Ÿ”‘

Access with

Advanced access token with business-account-draft-transfers.writeOAuth access with business-account-draft-transfers.write
Path Params
string
required
^badrt_.+$

Provide the ID of the related draft transfer.

Responses

Language
Credentials
LoadingLoadingโ€ฆ
Response
Choose an example:
application/hal+json