Cancel a transfer request

delete

https://api.anchorage-staging.com/v2/transfers/{transferId}

Permissions required: Transfer funds

Cancel a transfer request. Transfer requests in the QUEUED state can always be cancelled. Transfer requests in the IN_PROGRESS state can sometimes be cancelled if the request has not been broadcast on the blockchain. Trying to cancel a request that cannot be cancelled will return a 409 Conflict error code. Transfers can only be canceled by the API key responsible for creating that transfer (either created directly via CreateTransfer or indirectly via ExecuteHold)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transferId

string

required

The ID of the transfer to cancel

Headers

Api-Signature

string

required

^[0-9A-Fa-f]{128,160}$

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)

Api-Timestamp

int64

required

Current timestamp, represented as unix epoch seconds

Responses

204

Transfer request successfully cancelled

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request

401Unauthenticated

403Forbidden

404Not Found

409Conflict

429Too Many Requests

500Internal Server Error