Deposit History API
List your settlement deposits with pagination and sorting
Overview
The Deposit History endpoint lists the deposits made to your settlement account, so you can build your own reconciliation or statement view instead of downloading it from the portal.
📘 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/deposits |
GET | List your deposits, paginated and sortable |
Request
Query Parameters
| 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 |
| search | string | No | Free-text filter |
| start | integer | No | Offset for pagination (default 0) |
| length | integer | No | Page size, 1–100 (values outside this range are clamped) |
| sortColumn | string | No | Column to sort by |
| sortDirection | string | No | asc or desc |
Example request URL
GET https://panel.royat.sa/api/supplier/deposits?start=0&length=20&sortColumn=DepositDate&sortDirection=descResponse
Standard API response format. Data mirrors MyFatoorah's GetSupplierDeposits response — a list of deposit records for the account.
Support
For more information and support, please contact the Royat Pay team.