الرصيد والحركات / API v1

الحركات المالية

GET/api/partner/v1/ledger

Paged ledger for the authenticated partner and key environment.

المصادقة

Authorization: Bearer <PARTNER_API_KEY>

المفاتيح والبيئات وسياسة IP

معاملات الاستعلام

pageintegerاختياري

default: 1 · min: 1

sizeintegerاختياري

default: 20 · min: 1 · max: 100

typestringاختياري

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

directionstringاختياري

"CREDIT" · "DEBIT"

fromstringاختياري

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

tostringاختياري

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

الاستجابة

Paged ledger for the authenticated partner and key environment.

Cache-Control no-store

dataobjectمطلوب

عرض الحقول

itemsarrayمطلوب

عرض الحقول

entryIdstringمطلوب: uuid
modestringمطلوب: "LIVE" · "TEST"
directionstringمطلوب: "CREDIT" · "DEBIT"
typestringمطلوب: "TOP_UP" · "ORDER_CHARGE" · "ORDER_REVERSAL" · "RETURN" · "ADJUSTMENT" · "SETTLEMENT_PAYMENT"
amountMinorintegerمطلوب: int64 · min: 1 · max: 9007199254740991
balanceAfterMinorintegerمطلوب: int64 · min: -9007199254740991 · max: 9007199254740991
currencystringمطلوب: "SAR"
orderIdstring | nullمطلوب: uuid
externalReferencestring | nullمطلوب: max length: 160
createdAtstringمطلوب: date-time
allocatedMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
unallocatedMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991

paginationobjectمطلوب

عرض الحقول

pageintegerمطلوب
sizeintegerمطلوب
totalintegerمطلوب: int64
totalPagesintegerمطلوب

requestIdstringمطلوب

errorobject | nullمطلوب

null

تحتاج مساعدة في التكامل؟تواصل مع فريق قيفتو