Finance / API v1

Get balance

GET/api/partner/v1/balance

Current position for the authenticated key environment.

Authentication

Authorization: Bearer <PARTNER_API_KEY>

Response

Current position for the authenticated key environment.

Cache-Control no-store

dataobjectrequired

Show fields

modestringrequired: "LIVE" · "TEST"
settlementModestringrequired: "PREPAID" · "POSTPAID"
currencystringrequired: "SAR"
positionMinorintegerrequired: int64 · min: -9007199254740991 · max: 9007199254740991
availablePurchaseMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
creditLimitMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
overLimitbooleanrequired
asOfstringrequired: date-time

requestIdstringrequired

errorobject | nullrequired

null

Need help with your integration?Talk to the GiftU team