Finance / API v1

List ledger entries

GET/api/partner/v1/ledger

Paged ledger for the authenticated partner and key environment.

Authentication

Authorization: Bearer <PARTNER_API_KEY>

Keys, environments, and IP policy

Query parameters

pageintegeroptional

default: 1 · min: 1

sizeintegeroptional

default: 20 · min: 1 · max: 100

typestringoptional

"TOP_UP" · "ORDER_CHARGE" · "ORDER_REVERSAL" · "RETURN" · "ADJUSTMENT" · "SETTLEMENT_PAYMENT"

directionstringoptional

"CREDIT" · "DEBIT"

fromstringoptional

Inclusive UTC instant. When both bounds are supplied, from must be earlier than to and the range must not exceed 366 days. Either bound may be supplied alone.

date-time

tostringoptional

Exclusive UTC instant. When both bounds are supplied, to must be later than from and the range must not exceed 366 days. Either bound may be supplied alone.

date-time

Response

Paged ledger for the authenticated partner and key environment.

Cache-Control no-store

dataobjectrequired

Show fields

itemsarrayrequired

Show fields

entryIdstringrequired: uuid
modestringrequired: "LIVE" · "TEST"
directionstringrequired: "CREDIT" · "DEBIT"
typestringrequired: "TOP_UP" · "ORDER_CHARGE" · "ORDER_REVERSAL" · "RETURN" · "ADJUSTMENT" · "SETTLEMENT_PAYMENT"
amountMinorintegerrequired: int64 · min: 1 · max: 9007199254740991
balanceAfterMinorintegerrequired: int64 · min: -9007199254740991 · max: 9007199254740991
currencystringrequired: "SAR"
orderIdstring | nullrequired: uuid
externalReferencestring | nullrequired: max length: 160
createdAtstringrequired: date-time
allocatedMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
unallocatedMinorintegerrequired: int64 · min: 0 · max: 9007199254740991

paginationobjectrequired

Show fields

pageintegerrequired
sizeintegerrequired
totalintegerrequired: int64
totalPagesintegerrequired

requestIdstringrequired

errorobject | nullrequired

null

Need help with your integration?Talk to the GiftU team