Skip to main content
GET
Get ledger entries for all merchants

Authorizations

x-api-key
string
header
required

Company API key for authentication

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:20

Number of entries per page

Required range: 1 <= x <= 100
owner_id
string

Filter by owner ID

posting_set_id
string

Filter by posting set ID

event_id
string

Filter by event ID

type
enum<string>[]

Comma-separated list of entry types to filter by.

Available options:
TRANSACTION,
ORGANIZATION_FEE,
PLATFORM_COST,
PROVIDER_COST,
ORGANIZATION_ANTICIPATION_FEE,
PLATFORM_ANTICIPATION_COST,
PLATFORM_REFUND_COST,
PROVIDER_REFUND_COST,
TRANSACTION_REFUND,
TRANSACTION_REFUND_REVERSAL,
ORGANIZATION_FEE_REFUND,
PLATFORM_COST_REFUND,
PROVIDER_COST_REFUND,
TRANSACTION_DISPUTE,
TRANSACTION_DISPUTE_REVERSAL
operation
enum<string>

Filter by operation type

Available options:
CREDIT,
DEBIT
payment_date_from
string<date>

Start payment date (inclusive)

payment_date_to
string<date>

End payment date (inclusive)

transaction_id
string

Filter by transaction ID

refund_id
string

Filter by refund ID

cashout_id
string

Filter by cashout ID

settled
boolean

Filter by settled status

sort
enum<string>[]

Multi-field sort string (e.g., -created_at,amount). Allowed fields: created_at, payment_date, amount

Available options:
created_at,
payment_date,
amount,
-created_at,
-payment_date,
-amount

Response

Paginated list of ledger entries for all merchants

Paginated list of ledger entries

data
object[]
required

Array of ledger entries

pagination
object
required