Sign in

v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v1

Create a new transaction to a ledger

post/{ledger}/transactions

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

Query parameters

previewboolean
Example:true

Set the preview mode. Preview mode doesn't add the logs to the database or publish a message to the message broker.

Request body

timestampstring date-time
referencestring
metadataMetadata nullable

Example request

{
  "postings": [
    {
      "amount": 100,
      "asset": "COIN",
      "destination": "users:002",
      "source": "users:001"
    }
  ],
  "script": {
    "plain": "vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n",
    "vars": {
      "user": "users:042"
    }
  },
  "reference": "ref:001"
}

Response

OK

Example response

{
  "data": [
    {
      "postings": [
        {
          "amount": 100,
          "asset": "COIN",
          "destination": "users:002",
          "source": "users:001"
        }
      ],
      "reference": "ref:001",
      "preCommitVolumes": {
        "orders:1": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        },
        "orders:2": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        }
      },
      "postCommitVolumes": {
        "orders:1": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        },
        "orders:2": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        }
      }
    }
  ]
}