Perform a ledger transaction

POST

https://api.staging.vrtx.sa/testhelpers/ledger/transactions

Last modified:2025-12-17 20:39:28

Executes a transaction in the ledger with the specified postings. This endpoint proxies the Formance ledger API.

Request

Body Params application/jsonRequired

Example

Basic transaction

{
    "timestamp": "2025-11-13T05:31:56Z",
    "postings": [
        {
            "amount": 10000,
            "asset": "SAR",
            "source": "world",
            "destination": "9fa923f9-4a7c-42c6-accd-c1c276e36f9d"
        }
    ],
    "reference": "ref:87952",
    "metadata": {
        "admin": "true"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/testhelpers/ledger/transactions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timestamp": "2025-11-13T05:31:56Z",
    "postings": [
        {
            "amount": 10000,
            "asset": "SAR",
            "source": "world",
            "destination": "9fa923f9-4a7c-42c6-accd-c1c276e36f9d"
        }
    ],
    "reference": "ref:87952",
    "metadata": {
        "admin": "true"
    }
}'

Responses

🟢200OK

application/json

Transaction created successfully

Body

Example

{
    "transaction_id": "tx_1234567890",
    "reference": "ref:87952",
    "timestamp": "2025-11-13T05:31:56Z",
    "idempotent_hit": false
}

🟠400Bad Request

🟠409Conflict

🔴500Internal Server Error

Modified at 2025-12-17 20:39:28

Proxy PTY API calls

Top up an account in the ledger