POST/transactions

Create Transaction

Outcome - Sends an asset from one of your clients' wallets. Choose the source in one of two ways: walletId, or clientId plus assetId. Choose the destination in one of three ways: receiverAddress (any address), receiverClientId plus assetId (another client of the vault), or toMasterWallet: true plus assetId (the vault's master wallet). The transaction is created with status PENDING and may need approvals before it is sent.

Body Parameters

amountstringrequireddecimal

Amount to send, in the asset's normal unit (for example "0.1"). Send it as a string to keep full precision.

walletIdnumberpositive

Source wallet ID. Use either walletId, or clientId with assetId.

clientIdstring

Your client id (externalId) of the sender. Use with assetId, instead of walletId.

assetIdnumberpositive

Asset to send. Required with clientId, receiverClientId or toMasterWallet.

receiverAddressstringalphanumeric

Destination blockchain address. Do not combine with receiverClientId or toMasterWallet.

receiverClientIdstringalphanumeric

Your client id (externalId) of the recipient, when sending to another client of the vault. Needs assetId.

toMasterWalletbooleanboolean

true to send to the vault's master wallet for assetId.

idempotencyKeystringmax(100)

Your unique key for this transfer (max 100 characters). Sending the same key again returns the first transaction instead of creating a new one.

dataobject

Your own JSON metadata to store with the transaction (for example your payment reference). It is returned with the transaction.

Responses

Response attributes

messagestring

Success message

transactionobject

The created transaction, with the same fields as in Get Transaction Details

statusnumber

HTTP status code

Was this page helpful?