Get Account Balance

Singleview Open Banking AIS API retrieves bulk or single account balances from the Account Servicing Payment Service Provider (ASPSP), using the Consent ID and Account ID.

📘
Note

The represented flow assumes that the PSU/User has already consented to this access and has authorized Singleview Open Banking API platform to access this information

A bank account may have multiple balances to view and these shall be represented as Amount & Type.

1750 — Singleview Open Banking - Representation of process to fetch account balances through AIS

Endpoint details

Endpoint	Method	Grant type	Scope
`/v1/api/openBanking/accountsBalance`	POST	The header should include: 1. `clientId` 2. `clientCode` 3. `signature` 4. `sid` 5. `Authorization: Bearer`	Fetch single or multiple accounts balance using Account IDs

Request to get account balance - sample

{
  "SVAccountsBalanceRequest": {
    "DateTimeStamp": "2022-03-29T17:51:03",
     "RequestID": "{{RequestID}}",
    "userName": "{{userName}}",
    "SVAccountsInfoMessage": [
      {
        "SVAccountInfoRequest": {
          "BankCode": "SAMA",
          "ConsentId": "{{ConsentId}}",
          "Account_Id": "{{AccountId}}"
        }
      }
    ]
  }
}

Request Description

JSON Tag	Description	Data type
SVAccountsBalanceRequest Mandatory	Get account balance request tag	Object
DateTimeStamp Mandatory	Stamp denoting the request date and time	String
RequestID Mandatory	Unique request identification	String
userName Mandatory	Client Username	String
SVAccountsInfoMessage Mandatory	All accounts information message tag	Object
SVAccountInfoRequest Mandatory	Specific account information request tag	Array
BankCode Mandatory	Unique bank code for identification	String
ConsentId Mandatory	Unique consent identification	String
Account_Id Mandatory	Unique identifier for the account resource	String

Successfully fetched balance response - sample

{
    "success": true,
    "message": "",
    "SVAccountsBalanceResponse": {
        "SVAccountsInfoMessage": [
            {
                "SVAccountInfoResponse": {
                    "Data": {
                        "Balance": [
                            {
                                "AccountId": "9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf",
                                "Amount": {
                                    "Amount": 1500.00,
                                    "Currency": "SAR"
                                },
                                "CreditDebitIndicator": "Credit",
                                "Type": "ClosingAvailable",
                                "DateTime": "2017-10-10T00:00:00.000Z",
                                "CreditLine": [
                                    {
                                        "Included": true,
                                        "Type": "Temporary",
                                        "Amount": {
                                            "Amount": 500.00,
                                            "Currency": "SAR"
                                        }
                                    }
                                ]
                            },
                            {
                                "AccountId": "9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf",
                                "Amount": {
                                    "Amount": 1500.00,
                                    "Currency": "SAR"
                                },
                                "CreditDebitIndicator": "Credit",
                                "Type": "InterimAvailable",
                                "DateTime": "2017-10-10T00:00:00.000Z",
                                "CreditLine": [
                                    {
                                        "Included": true,
                                        "Type": "Temporary",
                                        "Amount": {
                                            "Amount": 500.00,
                                            "Currency": "SAR"
                                        }
                                    }
                                ]
                            }
                        ]
                    },
                    "Links": {
                        "Self": "https://rs1.lab.openbanking.sa/open-banking/v3.1/aisp/accounts/9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf/balances"
                    },
                    "Meta": {
                        "TotalPages": 1
                    },
                    "BankCode": "SAMA",
                    "ConsentId": "aac-b9a73147-7a1d-4ec9-bbbe-c8db6e21d65c"
                }
            }
        ]
    }
}

Response Description

JSON Tag	Description
success	Process success status represented as `True` or `False`
message	Process execution message
SVAccountsBalanceResponse	Get account balance response tag
SVAccountsInfoMessage	Get accounts information response tag
SVAccountInfoResponse	Specific account information response tag
Data	Data tag for account information
Balance	A list of balances regarding the account
Amount	Amount of money of the cash balance
Currency	Identification of the currency reflected for the account
CreditDebitIndicator	Indicates whether the balance is a credit or a debit balance
Type	Indicates the balance types
Links	Redirect links
Self	Own link/url details
Meta	Meta tag
TotalPages	Information displayed on number of pages
ItemCount	Number of total accounts shown or listed