Create a transaction

Create a transaction.

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
Request Body schema: application/json

attributes of the transaction to create

account_id
integer or null
Default: null

The account's id

account_name
required
string

The account's name.

amount
string or null^[0-9]*(\.[0-9]+)?$
Default: null

The amount to be sent, in the currency's lowest unit. For Smart Contract interaction, use "0" instead of null

(BitcoinFieldsLAM (object or null)) or (TezosFieldsLAM (object or null)) or (EthereumAndEvmFieldsLAM (object or null)) or (RippleFieldsLAM (object or null)) or (StellarFieldsLAM (object or null)) or (SolanaStakeCreateAndDelegateFieldsLAM (object or null)) or (SolanaStakeActionFieldsLAM (object or null)) or (SolanaStakeMergeFieldsLAM (object or null)) or (CardanoFieldsLAM (object or null)) or (PolkadotFieldsLAM (object or null))
Default: null

coin specific data

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

Max fees represent the highest possible fee amount you will pay to broadcast this transaction. The final fees, calculated once the transaction is approved by the last Operator, might be lower, but will never exceed that amount. We recommend estimating max fees through our fee estimation endpoint prior to creating the transaction request. See https://help.vault.ledger.com/developer-portal/content/transactions/tx/ for details.For Solana and Polkadot, max_fees field must be ignored.

object or null
Default: null

A title and comments for the transaction.

recipient
required
string

The recipient's address.

speed
required
string

The transaction's processing speed.

Enum: "CUSTOM" "FAST" "NORMAL" "SLOW"
Responses
200

Transaction to approve

400

Invalid transaction parameters

post/transactions
Request samples
application/json
{
  • "account_id": null,
  • "account_name": "string",
  • "amount": null,
  • "coin_fields": null,
  • "max_fees": "string",
  • "note": null,
  • "recipient": "string",
  • "speed": "CUSTOM"
}
Response samples
application/json
{
  • "account_id": 1,
  • "account_index": 0,
  • "amount": "1432199",
  • "block": null,
  • "broadcast_on": "2020-12-11T12:56:35.370946+00:00",
  • "coin_fields": {
    },
  • "compliance": null,
  • "confirmations": 28,
  • "created_by": 5,
  • "created_on": "2019-08-24T14:15:22Z",
  • "currency": "bitcoin",
  • "currency_family": "ethereum",
  • "fees": 17500,
  • "id": 0,
  • "interaction_type": null,
  • "labels": [
    ],
  • "last_request": null,
  • "max_fees": 2100,
  • "metadata": null,
  • "min_confirmations": 6,
  • "notes": [
    ],
  • "recipient": "tb1q2tvjts80vthcywq9au2yynpezca57mvv0j7lzm",
  • "senders": [
    ],
  • "speed": "NORMAL",
  • "status": "PENDING_APPROVAL",
  • "tx_hash": "cd199dd0c61ff75c7a442e425771fedfe07e191a76aed64b6a311ec4a369b20e",
  • "type": "SEND",
  • "uid": null
}
Copyright © Ledger Enterprise Platform 2023. All right reserved.