Sign in

v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v2

Bulk request

post/v2/{ledger}/_bulk

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

Query parameters

continueOnFailureboolean
Example:true

Continue on failure

atomicboolean
Example:true

Make bulk atomic

parallelboolean
Example:true

Process bulk elements in parallel

schemaVersionstring
Example:v1.0.0

Default schema version to use for validation (can be overridden per element)

Request body

Example request

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

Response

OK

errorCode'INTERNAL' | 'INSUFFICIENT_FUND' | 'VALIDATION' | 'CONFLICT' | 'COMPILATION_FAILED' | 'METADATA_OVERRIDE' | 'NOT_FOUND' | 'REVERT_OCCURRING' | 'ALREADY_REVERT' | 'NO_POSTINGS' | 'LEDGER_NOT_FOUND' | 'IMPORT' | 'TIMEOUT' | 'BULK_SIZE_EXCEEDED' | 'INTERPRETER_PARSE' | 'INTERPRETER_RUNTIME' | 'LEDGER_ALREADY_EXISTS' | 'SCHEMA_ALREADY_EXISTS' | 'SCHEMA_NOT_SPECIFIED' | 'OUTDATED_SCHEMA'
errorMessagestring

Example response

{
  "data": [
    {
      "data": {
        "postings": [
          {
            "amount": 100,
            "asset": "COIN",
            "destination": "users:002",
            "source": "users:001"
          }
        ],
        "reference": "ref:001",
        "metadata": {
          "admin": "true"
        },
        "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
            }
          }
        },
        "preCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "postCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        }
      }
    }
  ],
  "errorCode": "VALIDATION",
  "errorMessage": "[VALIDATION] invalid 'cursor' query param"
}