Live Balance API

Read your pending, deposited, and total balance in real time

Overview

The Live Balance endpoint returns your settlement account's balance directly from Royat Pay — the same figures shown on your portal dashboard — so you can display or reconcile them from your own platform without waiting for a scheduled report.

📘 Request Header: Add "Authorization": "Bearer {Token}" to the request header. Your client token can be found in your portal account settings.

API Endpoint

Endpoint	Method	Description
`/api/supplier/dashboard`	GET	Get your live pending/deposited/total balance and transaction counts

Request

Query Parameter

Parameter	Type	Required	Description
SupplierCode	integer	No	Only needed if your account settles for more than one settlement account — otherwise your default settlement account is used automatically

Example request URL

GET https://panel.royat.sa/api/supplier/dashboard

Response

{
  "IsSuccess": true,
  "Message": null,
  "ValidationErrors": null,
  "Data": {
    "TotalBalance": 3905.000,
    "TotalDepositedAmount": 12500.000,
    "TotalValueOfTransactions": 5000.000,
    "TotalNumberOfTransactions": 42
  }
}

Data fields

Field	Description
TotalBalance	Balance currently available to you (net of fees/commissions)
TotalDepositedAmount	Amount already settled and deposited to your bank account
TotalValueOfTransactions	Value of transactions not yet settled
TotalNumberOfTransactions	Count of transactions not yet settled

📘 Caching: This is a live read against MyFatoorah — avoid polling it more than a few times per minute per account.

Support

For more information and support, please contact the Royat Pay team.