Get wallet balance

Wallet

GET/api/v1/wallet/balance

Self-only by construction — there is no partnerId parameter anywhere on this endpoint; the partner is whoever the bearer token identifies. availableBalance already accounts for active reservations (it is what you can actually spend right now).

Response

currencystring

currentBalancenumber (decimal)

availableBalancenumber (decimal)

currentBalance minus every active, non-expired reservation — the same figure the reserve/debit paths enforce.

displayCurrencystring

ratenumber

currentBalanceDisplaynumber

availableBalanceDisplaynumber

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Errors guide.

403The route is not available to your credential (FORBIDDEN).

404The partner has no wallet provisioned.

429Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.

503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.

504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.

cURL

curl --request GET \
  --url https://api-omni.linra.net/api/v1/wallet/balance \
  --header 'Authorization: Bearer $TOKEN'

JavaScript

const res = await fetch('https://api-omni.linra.net/api/v1/wallet/balance', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const { payload } = await res.json();

C#

var response = await httpClient.GetAsync("https://api-omni.linra.net/api/v1/wallet/balance");

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<PartnerWalletBalanceResponse>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "currency": "SAR",
    "currentBalance": 0,
    "availableBalance": 0,
    "displayCurrency": "string",
    "rate": 0,
    "currentBalanceDisplay": 0,
    "availableBalanceDisplay": 0
  },
  "details": null
}