Create a new batch of transactions to a ledger

POST /api/ledger/{ledger}/transactions/batch

Try it

Create a new batch of transactions to a ledger

cURL

curl --request POST \
  --url http://localhost/api/ledger/{ledger}/transactions/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactions": [
    {
      "postings": [
        {
          "amount": 100,
          "asset": "COIN",
          "destination": "users:002",
          "source": "users:001"
        }
      ],
      "reference": "ref:001",
      "metadata": {},
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ]
}
'

200

{
  "data": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "postings": [
        {
          "amount": 100,
          "asset": "COIN",
          "destination": "users:002",
          "source": "users:001"
        }
      ],
      "txid": 1,
      "reference": "ref:001",
      "metadata": {},
      "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
          }
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

Body

application/json

transactions · object[] · required

Show child attributes

transactions. postings · object[] · required

Show child attributes

transactions.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

transactions.postings. asset · string · required

Example:

"COIN"

transactions.postings. destination · string · required

Example:

"users:002"

transactions.postings. source · string · required

Example:

"users:001"

transactions. reference · string

Example:

"ref:001"

transactions. metadata · object

Show child attributes

transactions.metadata. {key} · any

transactions. timestamp · string<date-time>

Response

200

application/json

OK

data · object[] · required

Show child attributes

data. timestamp · string<date-time> · required

data. postings · object[] · required

Show child attributes

data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.postings. asset · string · required

Example:

"COIN"

data.postings. destination · string · required

Example:

"users:002"

data.postings. source · string · required

Example:

"users:001"

data. txid · integer<bigint> · required

Required range: x >= 0

data. reference · string

Example:

"ref:001"

data. metadata · object

Show child attributes

data.metadata. {key} · any

data. preCommitVolumes · object

Show child attributes

data.preCommitVolumes. {key} · object

Show child attributes

data.preCommitVolumes.{key}. {key} · object

Show child attributes

data.preCommitVolumes.{key}.{key}. input · integer<bigint> · required

data.preCommitVolumes.{key}.{key}. output · integer<bigint> · required

data.preCommitVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}

data. postCommitVolumes · object

Show child attributes

data.postCommitVolumes. {key} · object

Show child attributes

data.postCommitVolumes.{key}. {key} · object

Show child attributes

data.postCommitVolumes.{key}.{key}. input · integer<bigint> · required

data.postCommitVolumes.{key}.{key}. output · integer<bigint> · required

data.postCommitVolumes.{key}.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

Example:

{
  "orders:1": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  },
  "orders:2": {
    "USD": { "input": 100, "output": 10, "balance": 90 }
  }
}