Get your own wallet balance

GET

/api/v1/wallet/balance

const url = 'https://api-omni.linra.net/api/v1/wallet/balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

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).

Authorizations

partnerBearer

Responses

200

The caller’s wallet balance.

application/json

object

state

required

string

payload

required

details

object

payload

required

Deliberately narrower than the internal-admin wallet view — omits minBalanceThreshold (an internal risk/floor setting) and walletStructure/isActive (internal account topology).

object

currency

string

currentBalance

number format: decimal

availableBalance

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

number format: decimal

displayCurrency

string

nullable

rate

number

nullable

currentBalanceDisplay

number

nullable

availableBalanceDisplay

number

nullable

Example

{
  "state": "SUCCESS",
  "payload": {
    "currency": "SAR"
  }
}

404

The partner has no wallet provisioned.

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Examples

notFound

{
  "state": "NOT_FOUND_WALLET",
  "payload": null,
  "details": {}
}

429

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

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.