Skip to main content
POST
/
deliver
/
transfers
/
{id}
/
cancel
Cancel a transfer by id
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/transfers/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

​
id
string<uuid>
required

Orum generated unique id for the transfer you are canceling. Orum generated unique id for the resource.

Response

202 response.

​
message
string
required

An explanation for the status of the transfer cancellation request.