Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
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}

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