Open BankingB2B SuiteERP Integration
GuidesChangelog
Menu

Categories

Open BankingB2B SuiteERP Integration


  • GENERAL INFORMATION

    • Documentation guide
    • Documentation guide
    • SingleView B2B Core APIs
    • SingleView Open Banking
    • Platform architecture
    • KSAOB standards
    • Security best practices
  • Getting started

    • Introduction
    • Become a User
    • Quick Lookup
  • GETTING STARTED

    • Integration guide
    • Become a user
    • Integration guide
    • Prerequisites for Sandbox
    • Developer console
    • Establishing secure connection
    • Establish secure connection
    • Authenticating your request
    • Generate access token
    • Making your first test api call
    • Make test raw data API call
    • Prerequisites for production
    • Make test data use case API call
    • Moving to production
  • Authentication

    • Generate Signature
  • ERP API Services

    • Configure API Account
    • Create Group & Company
    • Supplier Services
    • Account Services
    • Balance Enquiry
    • Statements
    • IBAN Validation
    • POS Transactions
  • CONSENT MANAGEMENT

    • Overview
    • Create a consent
    • Retrieve consent details
    • Revoke a consent
  • AUTHENTICATION

    • Header parameters
    • Obtain access token
    • Generate signature
  • Data APIs

    • Account statement
    • Balance enquiry
    • IBAN verification
    • POS transactions
    • Raw statement
  • Raw Data APIs

    • Introduction
    • View accounts
    • View balance
    • View transactions
    • Identify account holders (Parties)
    • Review direct debits
    • Review scheduled payments
    • Review standing orders
  • Payment APIs

  • DATA USE CASE APIS

  • SADAD

  • Plug-and-Play Integrations

    • Payly
  • RESOURCES

    • POR Details
    • Error codes
    • Errors & codes
    • Collections
    • API version management
    • Bank connectivity
  • API Archives


Balance Enquiry

Retrieve single or multiple bank account balances

SingleView Balance Enquiry API service allows you to request and retrieve specific bank account balances within your ERP system to confirm sufficient balances before making a payment or track insights.

Get account balance

Endpoint details

Endpoint URL

Method

Authentication requirements

/v1/api/erp/svBalanceEnqService

POST

  1. clientid
  2. clientsecret
  3. signature

Sample request

Get Account Balance Sample Request
curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svBalanceEnqService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svBalanceEnqServiceRQ": {
  "groupCode": "5412",
  "company": [
    {
      "companyCode": "MYCOMPANY012",
      "userName": "Abdul1234",
      "account": [
        {
          "acERPcode": "54321"
        }                
      ]
    }
  ]
}
}'

Request description

JSON Tag

Description

Data Type

svBalanceEnqServiceRQ Mandatory

Root tag carrying information on the request payload

Object

groupCode Mandatory

Unique group identification code Length of input: Min 3 Characters Max 20 Characters

Numeric

company Mandatory

Tag carrying information about company

Object

companyCode Mandatory

Unique company identification code Length of input: Min 3 Characters Max 20 Characters

String

userName Mandatory

Unique user identification name Length of input: Min 3 Characters Max 20 Characters

String

acERPcode Mandatory

Unique account ERP identification code Min: 9 Characters

Alphanumeric

Sample response

Get Account Balance Sample Response
{
  "svBalanceEnqServiceRS": {
    "company": [
      {
        "companyCode": "MYCOMPANY012",
        "userName": "Abdul1234",
        "account": [
          {
            "acERPcode": "54321",
            "Balance": {
              "SequenceNum": "",
              "ReceiptTime": "2025-05-21T09:16:49",
              "AccountNumber": "5823697459876",
              "AccountCurrency": "SAR",
              "AccountStatus": "00",
              "AccountStatusDesc": "",
              "CustomerFullName": "",
              "AccountType": "CA",
              "AuthorizedOdLimit": "000000000000000",
              "LastCreditDate": "2025-05-20",
              "LastCreditAmount": "57.00",
              "AvailableBalance": 8948541125.63,
              "AvailableBalanceLCY": "",
              "OpeningBalanceLCY": "",
              "OpeningBalance": 8948541125.63,
              "ClosingBalance": 0,
              "DebitAllowed": true,
              "CreditAllowed": true,
              "StatusCode": "OK",
              "StatusDetail": "Success"
            }
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag

Description

Data Type

svBalanceEnqServiceRS

Tag carrying information on process response of account balance services

Object

company

Tag carrying information on company

Object

companyCode

Unique company identification code

Numerical

userName

Unique username

String

account

Tag carrying information on account requested for balance enquiry services

Object

acERPcode

Unique ERP account code

Alphanumeric

Balance

Tag carrying information on the balance details of the requested account

Object

SequenceNum

Unique sequence number of the transaction

String

ReceiptTime

Parameter denoting the time of the request and response

Date & Time

AccountNumber

Unique account number passed in the request for balance enquiry services

Alphanumeric

AccountCurrency

Currency of the account

Alphabetic

AccountStatus

Status of the account

Numeric

AccountStatusDesc

Details on the status description of the account

String

CustomerFullName

Full name of the customer

String

AccountType

Type of the account

String

AuthorizedOdLimit

Over draft limit of the account

Numeric

LastCreditDate

Date denoting the last credit transaction happened for the account

Date and Time

LastCreditAmount

Amount that is credited during the last credit transaction

Numeric

AvailableBalance

Available balance of the account

Numeric

AvailableBalanceLCY

Available balance of the account in local currency

Numeric

OpeningBalanceLCY

Opening balance of the account in local currency

Numeric

OpeningBalance

Opening balance of the account

Numeric

ClosingBalance

Closing balance of the account

Numeric

DebitAllowed

Status if the debit transactions allowed for the account to be mentioned as true or false

Boolean

CreditAllowed

Status if the credit transactions are allowed for the account to be mentioned as true or false

Boolean

StatusCode

Status code of the process for balance enquiry service

String

StatusDetail

Status details of the process for balance enquiry service

String

Updated June 16, 2026

Was this helpful?