Skip to main content
GET
List ledger entries

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Query Parameters

type
enum<string>

Only entries of this type.

Available options:
top_up,
charge,
refund,
refund_reversal,
adjustment,
dispute,
free_credit
cursor
integer

The nextCursor of the page before.

Required range: x >= 1
pageSize
integer
default:50

Entries per page.

Required range: 1 <= x <= 100

Response

One page of the organization's ledger, newest first.

data
object[]
required
pagination
object
required