Get Account Info

Singleview Open Banking AIS API allows the PSU/Users to retrieve account information from the Account Servicing Payment Service Provider (ASPSP), using the Consent ID. The API allows the users to access the account information for the Bank accounts that hold an active user consent. Once a consent is expired or is deleted, that specific bank account information shall be unavailable to access.

For all the consented bank accounts, there exists unique account ID that can be used to retrieve account information and data. Below are the details along with a sample request and response for retrieving account information through SingleView Open Banking API.

📘
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

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

Endpoint details:

Endpoint	HTTP Operation	Grant type	Scope
`/v1/api/openBanking/accountsById`	POST	The header should include: 1. `clientId` 2. `clientCode` 3. `signature` 4. `sid` 5. `Authorization: Bearer`	Fetch accounts information using Account IDs

Request to get account information - sample

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

Description:

JSON Tag	Description	Data type
SVAccountsByIdRequest Mandatory	Fetch account details by account ID 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	Accounts info message tag	Object
SVAccountInfoRequest Mandatory	Specific account info request tag	Object
BankCode Mandatory	Unique bank code for identification	String
ConsentId Mandatory	Unique consent identification	String
Account_Id Mandatory	Unique identifier for the account resource	String

Get account information response - sample

{
    "success": true,
    "message": "",
    "SVAccountsByIdResponse": {
        "SVAccountsInfoMessage": [
            {
                "SVAccountInfoResponse": {
                    "Data": {
                        "Account": {
                            "AccountId": "9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf",
                            "Currency": "SAR",
                            "Account": [
                                {
                                    "Name": "Maha Alosaimi",
                                    "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                                    "Identification": "00002680000003"
                                }
                            ]
                        }
                    },
                    "Links": {
                        "Self": "https://rs1.lab.openbanking.sa/open-banking/v3.1/aisp/accounts/9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf"
                    },
                    "Meta": {
                        "TotalPages": 1
                    },
                    "BankCode": "SAMA",
                    "ConsentId": "aac-b9a73147-7a1d-4ec9-bbbe-c8db6e21d65c"
                }
            }
        ]
    }
}

Description:

JSON Tag	Description
success	Process success status represented as `True` or `False`
message	Process execution message
SVAccountsByIdResponse	Fetch account details by Account ID response tag
SVAccountsInfoMessage	Accounts info message response tag
SVAccountInfoResponse	Specific account info response tag
Data	Data tag for account information
Account	Unambiguous identification of the account with credit and debit entries
AccountId	A unique identifier for the account resource
Currency	Identification of the currency reflected for the account
Account	Bank account details
Name	Name(s) of the account holder or owner
SchemeName	Name of the account's identification scheme
Identification	Unique identification of the servicing institution
Links	Redirect links
Self	Own link/url details
Meta	Meta tag
TotalPages	Information on number of pages
BankCode	Unique bank code for identification
ConsentId	Unique consent identification

Get List of All Accounts

The Get all accounts request allows the AISP to discover all the bank accounts (and AccountId(s)) that are associated with the authorization of consent. Eventually, the PSU/User can retrieve the list of accounts associated with the consent identity and consolidate all accounts through a single API request.

📘
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

Endpoint details:

End point	Method	Grant type	Scope
`/v1/api/openBanking/allAccounts`	POST	The header should include: 1. `clientId` 2. `clientCode` 3. `signature` 4. `sid` 5. `Authorization: Bearer`	Fetch the list of all bank accounts associated and authorized to a specific consent ID

Request to get list of all accounts

{
  "SVAllAccountsRequest": {
    "DateTimeStamp": "2022-05-26T17:51:03",
    "RequestID": "{{RequestID}}",
    "userName": "{{userName}}",
    "SVAccountsInfoMessage": [
      {
        "SVAccountInfoRequest": {
          "BankCode": "SAMA",
          "ConsentId": "{{ConsentId}}"
        }
      }
    ]
  }
}

Description:

JSON Tag	Description	Data type
SVAllAccountsRequest Mandatory	Get all accounts 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	Get all accounts info message tag	Object
SVAccountInfoRequest Mandatory	Get account info request specific account details tag	Object
BankCode Mandatory	Unique bank code for identification	String
ConsentId Mandatory	Unique consent identification	String

Successfully fetch all accounts response - sample

{
    "success": true,
    "message": "",
    "SVAllAccountsResponse": {
        "SVAccountsInfoMessage": [
            {
                "SVAccountInfoResponse": {
                    "Data": {
                        "Account": [
                            {
                                "AccountId": "9f9a3af9-d7ed-47bd-9dab-cff3d30c6bbf",
                                "Currency": "SAR",
                                "Account": [
                                    {
                                        "Name": "Maha Alosaimi",
                                        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                                        "Identification": "00002680000003"
                                    }
                                ]
                            },
                            {
                                "AccountId": "3376fdc5-2573-4e1b-bac5-ccbecc474131",
                                "Currency": "SAR",
                                "Account": [
                                    {
                                        "Name": "Maha Alosaimi",
                                        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                                        "Identification": "01002680000001"
                                    }
                                ]
                            },
                            {
                                "AccountId": "73cd6f30-0b24-4bdd-ad82-a20a304acf2b",
                                "Currency": "SAR",
                                "Account": [
                                    {
                                        "Name": "Maha Alosaimi",
                                        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                                        "Identification": "01002680000002"
                                    }
                                ]
                            }
                        ]
                    },
                    "Links": {
                        "Self": "https://rs1.lab.openbanking.sa/open-banking/v3.1/aisp/accounts"
                    },
                    "Meta": {
                        "TotalPages": 1
                    },
                    "BankCode": "SAMA",
                    "ConsentId": "aac-b9a73147-7a1d-4ec9-bbbe-c8db6e21d65c"
                }
            }
        ]
    }
}

Description:

JSON Tag	Description
success	Process success status represented as `True` or `False`
message	Process execution message
SVAllAccountsResponse	Get all accounts response tag
SVAccountsInfoMessage	Get all accounts info message tag
SVAccountInfoResponse	Specific account info response tag
Data	Data tag for account information
Account	Unambiguous identification of the account with credit and debit entries
AccountId	Unique identifier for the account resource
Currency	Identification of the currency reflected for the account
Account	Bank account details
Name	Name(s) of the account holder or owner
SchemeName	Name of the account's identification scheme
Identification	Unique identification of the servicing institution
Links	Redirect links
Self	Own link/url details
Meta	Meta tag
BankCode	Unique bank code for identification
TotalPages	Information on number of pages
ItemCount	Number of total items/accounts shown or listed