SchemeBalance
GET
https://test.api.neotek.sa/b2b-unified/va/v1/schemes/{schemeId}/balanceSandbox URL · in Production call https://api.neotek.sa
The balance of every VA in a scheme, plus aggregated totals.
Path parameters:
| Parameter | Required | Description |
|---|---|---|
schemeId | Required | the scheme id |
Query parameters:
| Parameter | Required | Description |
|---|---|---|
bankCode | Required | always RJHISARI |
Headers:
| Parameter | Required | Description |
|---|---|---|
authorization | Required | Bearer <ACCESS_TOKEN> |
x-app-id | Required | your application id |
cURL
curl -G 'https://test.api.neotek.sa/b2b-unified/va/v1/schemes/{schemeId}/balance' \ --header 'authorization: Bearer <ACCESS_TOKEN>' \ --header 'x-app-id: <APP_ID>' \ -d 'bankCode=RJHISARI'Response (trimmed to one remitter)
JSON
{ "success": true, "code": "SUCCESS", "message": "Scheme balance retrieved successfully", "schemeId": "SCHEME001", "vaCount": 3, "totalAvailableBalance": "120000.00", "totalClearingBalance": "120000.00", "currency": "SAR", "remitters": [ { "remitterIban": "SA4580000204000010006087", "availableBalance": "45000.00", "clearingBalance": "45000.00", "blockedBalance": "0.00" } ], "msgReference": "SBAL001"}For the totals without the per-VA breakdown, use SchemeTotalBalance.
Errors — every B2B failure carries a category that determines the HTTP status; see Statements → Errors.