Ask for an invitation
Menu

Endpoint

List ledger entries

GET/v1/ledger_entries

The merchant's money record, newest first: every movement in or out of a merchant wallet and every fee.

Scope a restricted key needs
wallets:read
Publishable key
Not allowed: secret or restricted key only
Idempotency-Key
Not used. A GET is already safe to repeat.

Parameters

Parameters of List ledger entries
ParameterType and placeMeaning
typestringqueryOne or several types.
walletstringqueryOnly entries of this wal_ id.
assetstringqueryOnly entries of this asset id.
orderstringqueryOnly entries of this ord_ id.
sourcestringqueryThe id of the payment, refund, payout or conversion.
limitintegerqueryItems per page, 1 to 100. Default 20.
starting_afterstringqueryAn object id: return the items after it.
ending_beforestringqueryAn object id: return the items before it.
created[gte]string (date-time)queryCreated at or after. Also created[gt], created[lte], created[lt].
created[lt]string (date-time)queryCreated before.
Orrerie-VersionstringheaderAPI version date. Default: the version the key was created with. Example 2026-10-11.

Example request

curl

curl https://api.orrerie.com/v1/ledger_entries \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/ledger_entries", {
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
  },
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);

Python

import os
import requests

response = requests.get(
    "https://api.orrerie.com/v1/ledger_entries",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)

PHP

<?php
$request = curl_init('https://api.orrerie.com/v1/ledger_entries');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
    ],
]);
$body = curl_exec($request);
if ($body === false) {
    throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
    throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);

Responses

200 OK

A list whose data holds ledger_entry objects. Headers: Orrerie-Request-Id.

Example response, 200

{
  "object": "list",
  "url": "/v1/ledger_entries",
  "has_more": false,
  "data": [
    {
      "id": "le_d1jr8qbcjryqrqt72pxzk44n",
      "object": "ledger_entry",
      "livemode": true,
      "created": "2026-10-11T14:09:55.764Z",
      "type": "payment",
      "wallet": "wal_bsfw07hymawmda7gg8jsyy3g",
      "asset": "base:usdc",
      "amount": "21.990000",
      "direction": "in",
      "value": {
        "amount": "21.99",
        "currency": "USD"
      },
      "order": "ord_0zymngngvf12b8b2cra7tb8e",
      "source": "pay_2pe50hae6w2jk4sp1rcq5pae",
      "transaction_hash": "0x27ca64c092a959c7edc525ed45e845b1de6a7590d173fd2fad9133c8a779a1e3",
      "description": "Order #1042"
    }
  ]
}

Any other status: an error

A status of 400 or above answers with the error object. Branch on its code, never on its message.

Errors

This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.