Back to neotek ↗Get Sandbox Access

VABalance

GEThttps://test.api.neotek.sa/b2b-unified/va/v1/remitters/{remitterId}/balance

Sandbox URL · in Production call https://api.neotek.sa

The available, clearing and blocked balances on one VA.

Path parameters:

ParameterRequiredDescription
remitterIdRequiredthe VA identifier

Query parameters:

ParameterRequiredDescription
bankCodeRequiredalways RJHISARI
remitterIbanRequiredthe VA IBAN, SA plus 22 digits

Headers:

ParameterRequiredDescription
authorizationRequiredBearer <ACCESS_TOKEN>
x-app-idRequiredyour application id
cURL
curl -G 'https://test.api.neotek.sa/b2b-unified/va/v1/remitters/{remitterId}/balance' \  --header 'authorization: Bearer <ACCESS_TOKEN>' \  --header 'x-app-id: <APP_ID>' \  -d 'bankCode=RJHISARI' \  -d 'remitterIban=SA4580000204000010006087'

Response

JSON
{  "success": true,  "code": "SUCCESS",  "message": "Balance retrieved successfully",  "remitterId": "CUST001",  "remitterIban": "SA4580000204000010006087",  "availableBalance": "45000.00",  "clearingBalance": "45000.00",  "blockedBalance": "0.00",  "currency": "SAR",  "schemeId": "SCHEME001",  "msgReference": "BAL001"}

The three balances differ:

  • availableBalance – funds available for withdrawal or payment
  • clearingBalance – funds cleared, which may still include blocked amounts
  • blockedBalance – funds held via BlockAndReleaseFunds

Errors — every B2B failure carries a category that determines the HTTP status; see Statements → Errors.

PreviousVAStatusInquiryNextVAStatement