Fetch Balance

GET 
/balance

Retrieve your current Moyasar balance, the same figures shown on the dashboard balance card: recent payments still being processed, funds awaiting your next settlement, funds in a settlement being prepared, and the total amount already settled to your bank account.

All amounts are after fees, as integers in the smallest currency unit (e.g. halalas for SAR, so 30000 is 300.00 SAR).

Responses

200

Successful operation

application/json

Schema

Schema

currency Currency (string)

ISO-4217 three-letter currency code.

total integer

Processing payments plus funds awaiting settlement, in the primary currency.

available integer

Processed funds awaiting your next settlement, in the primary currency.

transferred integer

Total amount settled to your bank account to date.

balances

object[]

Balance per transaction currency. The settlement currency is listed first.

Only returned in live mode.

Array [

currency Currency (string)

ISO-4217 three-letter currency code.

settles_in string

Currency this balance is settled to your bank account in.

pending integer

Recent payments, after fees, that are still being processed. Once processed, they move to available.

available integer

Processed funds awaiting your next settlement.

in_settlement integer

Funds included in a settlement being prepared for your bank account. Once sent, the settlement appears in List Settlements.

updated_at timestamp

Date and time when this balance last changed.

]

Example (from schema)

{
  "currency": "SAR",
  "total": 150000,
  "available": 100000,
  "transferred": 2500000,
  "balances": [
    {
      "currency": "SAR",
      "settles_in": "SAR",
      "pending": 50000,
      "available": 100000,
      "in_settlement": 0,
      "updated_at": "2026-11-03T09:30:00.000Z"
    }
  ]
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

Loading...