Cancel a transfer request

curl --request DELETE \
  --url https://api.anchorage-staging.com/v2/transfers/{transferId} \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>'

import requests

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

headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>'
  }
};

fetch('https://api.anchorage-staging.com/v2/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

Cancel a transfer request

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)

DELETE

transfers

{transferId}

Cancel a transfer request

curl --request DELETE \
  --url https://api.anchorage-staging.com/v2/transfers/{transferId} \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>'

import requests

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

headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>'
  }
};

fetch('https://api.anchorage-staging.com/v2/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

Authorizations

Api-Access-Key

string

header

required

An API key associated with a security role

Headers

Api-Signature

string

required

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)
  )
)

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

Api-Timestamp

integer<int64>

required

Current timestamp, represented as unix epoch seconds

Path Parameters

transferId

string

required

The ID of the transfer to cancel

Response

Transfer request successfully cancelled

Get transfer by ID Create a withdrawal request

⌘I