Transfers

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}

Request

Base URL
https://api.anchorage-staging.com/v2
Auth
API key in header Api-Access-Key
TypeScript
https://skmtc.dev/anchorage/apis/anchorage-digital-api-reference/docs/transfers/:transferId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

transferIdstring required

The ID of the transfer to cancel

Headers

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

Api-Timestampinteger required

Current timestamp, represented as unix epoch seconds

Response

Transfer request successfully cancelled

Changes

No recorded changes to this operation across all 1 revision of this API.