Transfers

Cancel Crypto Transaction

Cancels an outgoing crypto transfer that is under review and has not been sent. Returns the transfer with its new status. A transfer that is already being sent cannot be canceled.

post/accounts/{account_id}/crypto/{transaction_id}/cancel

Request

Path parameters

account_idstring required

The ID of the account.

transaction_idstring uuid required

The ID returned when you created the transfer.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

amountstring required

Size of the transaction, in USD. Always positive, in both directions.

direction'inbound' | 'outbound' required
status'pending' | 'pending_approval' | 'canceled' | 'processing' | 'error' | 'sent' | 'returned' | 'void' required
destination_addressstring required

On-chain address the funds were sent to.

destination_payment_rail'ethereum' | 'base' | 'solana' | 'arbitrum' | 'polygon' | 'optimism' | 'tron' | 'stellar' | 'avalanche_c_chain' | 'binance' | 'sui' | 'tempo' | 'xdc' | 'bitcoin' | 'ripple' required
destination_tx_hashstring nullable

On-chain hash of the transfer we sent. Set on outbound transactions once they settle.

destination_address_nicknamestring nullable

Nickname of the contact that owns the destination address. null when the address is not attached to a contact, which is the usual case for inbound deposits.

source_addressstring nullable

On-chain address the funds were sent from. Set on inbound deposits, so you can match a deposit to whoever sent it.

source_tx_hashstring nullable

On-chain hash of the deposit. Set on inbound deposits.

metadataobject nullable

The metadata attached when this object was created, unchanged. null when none was attached. Rarely, a .created webhook can be published before the create request finishes committing, and that one event reports null; every later event and every read of the object carries the metadata.

Changes

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