Initiate new On-chain Transaction

Initiate a new on-chain transaction to withdraw funds

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required

Unique ID to ensure idempotency

string
required

Code of asset to transfer

to
object
required

On-chain destination or source address, with an optional tag/memo.

string
required
^-?[0-9]+(\.[0-9]+)?$

The total amount to be sent by the customer

fee
required
string | null

Optional memo to attach to transaction.

string | null

Optional backend vendor, defaults to default custody vendor

Responses

400

Possible reasons:

  • a base asset must have a Base fee or a non_base asset must have a NonBase fee, but not any other combination
  • amount must be positive
  • could not parse fee_amount
  • custody vendor not configured
  • fee_amount must be greater than or equal to zero
  • tag_memo is not supported for this asset
  • tag_memo is required for this asset
  • transaction with this external_id was already attempted
  • unknown asset_code
401

Not authenticated

403

the authority account cannot be used as the account for a transaction

404

Not found

409

user is archived

422

The request body is valid JSON but does not match the expected schema.

500

Possible reasons:

  • attempt to verify existing contract failed
  • could not begin transactional query
  • database error
  • failed to build contract
  • failed to commit database transaction
  • failed to create transaction
  • failed to get asset code
  • failed to get recipient user address
  • failed to get recipient user vault
  • failed to get treasury user
  • failed to look up connector
  • failed to look up recipient user
  • failed to save contract
  • treasury user is not configured
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json