Aggregate accounts

Account Aggregation enables you to access data from multiple customer accounts through a single authorized consent. Rather than making separate requests for individual account IDs, aggregation services provide a consolidated view of customer banking information across all accounts associated with the consent.

This capability is commonly used in personal finance applications, lending platforms, financial dashboards, account verification services, and customer financial profiling solutions.

Account Aggregation service allows you to retrieve customer banking data across all eligible accounts linked to an authorized consent.

Using a single consent, you can access aggregated:

Account information
Balances
Transactions
Direct debits
Standing orders
Scheduled payments

Each aggregation service is exposed through a dedicated API endpoint.

Access to this API requires a valid consent that has been authorized by the customer.

Important information

The consentId must refer to an active and authorized consent
A valid access token must be included in the Authorization: Bearer header

This API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.

The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.

If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.

Scope	useCaseType	Permissions
To access Account Aggregation service under Data Use Case APIs	`ACCOUNTAGGREGATION`	`"ReadAccountsBasic",` `"ReadAccountsDetail",` `"ReadBalances",` `"ReadParty",` `"ReadPartyPSU",` `"ReadPartyPSUIdentity",` `"ReadBeneficiariesBasic",` `"ReadBeneficiariesDetail",` `"ReadTransactionsBasic",` `"ReadTransactionsDetail",` `"ReadTransactionsCredits",` `"ReadTransactionsDebits",` `"ReadScheduledPaymentsBasic",` `"ReadScheduledPaymentsDetail",` `"ReadDirectDebits",` `"ReadStandingOrdersBasic",` `"ReadStandingOrdersDetail"`

Scope

useCaseType

Permissions

To access Account Aggregation service under Data Use Case APIs

ACCOUNTAGGREGATION

"ReadAccountsBasic",

"ReadAccountsDetail",

"ReadBalances",

"ReadParty",

"ReadPartyPSU",

"ReadPartyPSUIdentity",

"ReadBeneficiariesBasic",

"ReadBeneficiariesDetail",

"ReadTransactionsBasic",

"ReadTransactionsDetail",

"ReadTransactionsCredits",

"ReadTransactionsDebits",

"ReadScheduledPaymentsBasic",

"ReadScheduledPaymentsDetail",

"ReadDirectDebits",

"ReadStandingOrdersBasic",

"ReadStandingOrdersDetail"

Retrieve Aggregated Account Details

This service requires consentId and returns the account information of all the accounts associated with the consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/getAllAccountsAggregation`	GET

Header

The following headers must be included when calling the Accounts Aggregation API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve aggregated accounts' information

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/getAllAccountsAggregation?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&accountAggregation=true&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response of a successfully retrieved aggregated accounts information request

{
"success": true,
"payload": [
{
"code": "SABB",
"data": {
"account": [
{
"accountId": "100004000000000000000001",
"accountHolderName": "Mohammad Alhajri",
"accountHolderShortName": "Alhajri",
"status": "Active",
"currency": "SAR",
"nickname": "Mohammad",
"accountType": "KSAOB.Corporate",
"accountSubType": "Business Current Account",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "SA5678907654334454445601",
"name": "Mohammad Alhajri"
},
{
"identificationType": "KSAOB.NationalID",
"identification": "2123456789",
"name": "Mohammad Alhajri"
},
{
"identificationType": "KSAOB.CommercialRegistrationNumber",
"identification": "5566456733",
"name": "Saudi Company"
}
],
"servicer": {
"identificationType": "KSAOB.BICFI",
"identification": "10000109010101"
},
"statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
"description": "Account sub-type description",
"openingDate": "2022-04-08T16:37:00.980Z",
"maturityDate": "2023-11-29T16:37:00.980Z"
}
]
},
"links": {
"self": ""
},
"meta": {
"totalPages": 1
}
}
]
}

Response parameters

Parameter	Description	Data type	Data validation
success	Indicates whether the request was successfully processed	Enum	`true` or `false`
payload	Contains account information grouped by bank	Array of objects
code	Bank identifier associated with the account data	Enum
data	Contains account details returned from the bank	Object
account	List of accounts associated with the consent	Array of objects
accountId	Unique identifier of the account	String
accountHolderName	Full name of the account holder	String
accountHolderShortName	Short or display name of the account holder	String
status	Current status of the account	Enum	`Active` or `Inactive`
currency	Currency in which the account operates	String
nickname	Nickname assigned to the account	String
accountType	Specifies the type of accounts that can be accessed	Enum	`retail` or `corporate`
accountSubType	Specifies the type of accounts that can be accessed	Enum	`Savings` or `CurrentAccount` or `CreditCard` or `EMoney`
accountIdentifiers	Each account may contain one or more identifiers that uniquely identify the account	Object
identificationType	Type of identifier used	String
identification	Identifier value associated with the account	String
name	Name associated with the identifier	String
servicer	This contains information about the financial institution servicing the account	Object
identificationType	Type of bank identifier used	String
identification	Identifier value of the servicing institution	String
statusUpdateDateTime	Date and time when the account status was last updated by the servicing bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
description	Additional information or description associated with the account subtype or account characteristics	String
openingDate	Date and time when the account was originally opened at the bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
maturityDate	Date when the account reaches maturity. This field is typically applicable for term-based accounts.	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
links	Contains reference links related to the API response or resource	Object
self	Link referencing the current API resource or endpoint that returned the response	String
meta	Provides additional metadata related to the API response, such as pagination information	Object
totalPages	Indicates the total number of pages available in the response when pagination is applied	Integer

View All Accounts Balance

This service requires consentId and returns all balances of accounts associated with that consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/allAccountsBalanceAggregation`	GET

Header

The following headers must be included when calling the Aggregated Balance API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve aggregated balances of all the accounts

curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/allAccountsBalanceAggregation?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&accountAggregation=true&bankCode=SABB&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
--header 'accept: application/json' \
--header 'authorization: Bearer asdrtyuiokjhgfrtyujhdd'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response for a successfully retrieved balances of aggregated accounts information request

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "consentId": "urn:SVMOB:kac-6135f5a3-2480-4c73-97d8-e6eb75291a3e",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              },
              {
                "identificationType": "KSAOB.NationalID",
                "identification": "2123456789",
                "name": "Mohammad Alhajri"
              },
              {
                "identificationType": "KSAOB.CommercialRegistrationNumber",
                "identification": "5566456733",
                "name": "Saudi Company"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "balance": [
              {
                "amount": {
                  "amount": "213.00",
                  "currency": "SAR"
                },
                "creditDebitIndicator": "KSAOB.Credit",
                "type": "KSAOB.ClosingAvailable",
                "dateTime": "2022-11-22T06:26:50.593Z",
                "creditLine": [
                  {
                    "included": true,
                    "type": "KSAOB.Temporary",
                    "amount": {
                      "amount": "534.00",
                      "currency": "SAR"
                    }
                  }
                ]
              }
            ]
          }
        ],
        "totalOpeningBalance": 213,
        "totalAvailableBalance": 213,
        "totalClosingAvailable": 213,
        "currency": "SAR"
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ],
  "overAllBalance": {
    "totalOpeningBalance": 213,
    "totalAvailableBalance": 213,
    "totalClosingAvailable": 213,
    "currency": "SAR"
  }
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and balances data included in the response
accountId	Unique account identification
accountHolderName	Name of the account holder
accountHolderShortName	Short name of the account holder
status	Status of the account
currency	Default currency of the account
nickname	Nickname of the account
accountType	Details of account type
accountSubType	Details of account sub-type
accountIdentifiers	Tag carrying account identifiers details
identificationType	Account identification type details
identification	Account identification details
name	Name of the account identifier
servicer	Tag carrying account servicer details
identificationType	Servicer identification type details
identification	Servicer identification details
statusUpdateDateTime	Last time and date of update for account information
description	Description of the update
openingDate	Opening date of the account
maturityDate	Maturity date of the account
balance	Tag carrying account balance information
amount	Tag carrying cash balance information
amount	Cash balance amount
currency	Default currency of the account in which the balance is indicated
creditDebitIndicator	Indicates whether the balance is a credit or a debit balance
type	Indicator type details
dateTime	Date and time information of the indicator
creditLine	Tag carrying credit line information
included	Status of credit line as `included` or `excluded`
type	Type of credit line details
amount	Tag carrying amount information of credit line
amount	Available amount in credit line
currency	Currency in which the credit line balance is indicated
totalOpeningBalance	Total opening balance
totalAvailableBalance	Total available balance
totalClosingAvailable	Total closing balance
currency	Currency of the total balances
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages
overallBalance	Tag carrying information on overall balances
totalOpeningBalance	Total opening balance
totalAvailableBalance	Total available balance
totalClosingBalance	Total closing balance
currency	Currency of the overall balance indicated

View All Accounts Transactions

This service requires consentId to return all transactions of account associated with that consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/allAccountsTransactions`	GET

Header

The following headers must be included when calling the Transaction API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve all accounts' transactions

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/allAccountsTransactions?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&fromDate=2016-01-01T10%3A40%3A00%2B02%3A00&toDate=2025-12-31T10%3A40%3A00%2B02%3A00&accountAggregation=true&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
fromDate	Mandatory	Starting date of the transaction period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
toDate	Mandatory	Final day of the transaction period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response for a successfully retrieved transactions of an account

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "consentId": "urn:SVMOB:kac-35234830-aa97-474a-a5bc-0ee6ab91e00a",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "transactions": [
              {
                "transactionId": "687b3b16-9ce0-4f27-8d88-bf62335890b0",
                "transactionDateTime": "2025-12-07T04:53:00.000Z",
                "transactionReference": "52548391-ec27-49d8-8e23-d9d27ebb347b",
                "transactionType": "KSAOB.InternationalTransfer",
                "subTransactionType": "KSAOB.NotApplicable",
                "paymentModes": "KSAOB.Offline",
                "creditDebitIndicator": "KSAOB.Debit",
                "status": "KSAOB.Booked",
                "transactionMutability": "KSAOB.Mutable",
                "bookingDateTime": "2025-12-07T04:53:00.000Z",
                "valueDateTime": "2025-12-07T04:53:00.000Z",
                "amount": {
                  "amount": "382.82",
                  "currency": "SAR"
                },
                "chargeAmount": {
                  "amount": "6.20",
                  "currency": "SAR",
                  "chargeIncluded": false
                },
                "balance": {
                  "creditDebitIndicator": "KSAOB.Credit",
                  "type": "KSAOB.ClosingAvailable",
                  "amount": {
                    "amount": "2656.67",
                    "currency": "SAR"
                  }
                },
                "localTimeZone": "UTC+03:00",
                "terminalId": 27389350,
                "chargeAmountVat": {
                  "amount": "50.55",
                  "currency": "SAR"
                },
                "flags": [
                  "KSAOB.Payroll"
                ],
                "cardInstrument": {
                  "cardSchemeName": "KSAOB.AmericanExpress",
                  "instrumentType": "KSAOB.ApplePay",
                  "name": "test",
                  "identification": "1234********3126"
                },
                "creditorAccount": [
                  {}
                ],
                "debtorAccount": {
                  "identificationType": "KSAOB.IBAN",
                  "identification": "string",
                  "name": "string"
                },
                "transactionInformation": "خصم اجمالي ملف الرواتب من خلال المركز الرئيسى المبلغ SAR 469553.92 العملة الريال تاريخ الاستحقاق 08/26/2024 ، وقت إنشاء العملية 1212 الرقم المرجعي FT24239JGMFC سعر الصرف 1.00 رسوم الإيداع 0.00 الغرض من الإيداع",
                "bankTransactionCode": {
                  "domain": "domain",
                  "domainCode": "domainCode",
                  "family": "family",
                  "familyCode": "familyCode",
                  "subFamily": "subFamily",
                  "subFamilyCode": "subFamilyCode"
                },
                "proprietaryBankTransactionCode": {
                  "code": "code",
                  "issuer": "issuer"
                },
                "creditorAgent": {
                  "identificationType": "KSAOB.BICFI",
                  "identification": "KSAOB.BICFI",
                  "postalAddress": {
                    "addressType": "KSAOB.Business",
                    "streetName": "streetName",
                    "buildingNumber": "1234",
                    "postalCode": "12345",
                    "city": "townName",
                    "country": "SA",
                    "shortAddress": "address",
                    "unitNumber": 1234,
                    "secondaryNumber": "1234",
                    "district": "district"
                  },
                  "name": "Ali"
                },
                "debtorAgent": {
                  "identificationType": "KSAOB.BICFI",
                  "identification": "string",
                  "postalAddress": {
                    "addressType": "KSAOB.Business",
                    "streetName": "streetName",
                    "buildingNumber": "1234",
                    "postalCode": "12345",
                    "city": "townName",
                    "country": "SA",
                    "shortAddress": "address",
                    "unitNumber": 1234,
                    "secondaryNumber": "1234",
                    "district": "district"
                  },
                  "name": "Ahmed"
                },
                "billDetails": {
                  "billerId": 100004,
                  "billNumber": "1234",
                  "billPaymentType": "KSAOB.Renewal"
                }
              }
            ]
          }
        ]
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and transactions data included in the response
account	Tag carrying information on all the accounts included in the consent
accountId	Unique account identification
transactions	Tag carrying account transactions information
transactionId	Unique transaction identification
transactionDateTime	Time and date of the transaction executed
transactionReference	Unique transaction reference details
transactionType	Type of transaction
subTransactionType	Sub-type of the transaction
paymentModes	Mode of the payment
creditDebitIndicator	Credit or debit indicator for the transaction
status	Status of the transaction
transactionMutability	Mutability factor of the transaction
bookingDateTime	Date and time of booking the transaction
valueDateTime	Date and time of transaction value
amount	Tag carrying transaction amount information
amount	Transaction amount
currency	Default currency of the account in which the transaction amount is indicated
chargeAmount	Tag carrying transaction charges information
amount	Total amount charged for the transaction
currency	Default currency of account in which the transaction charge amount is indicated
chargeIncluded	Indicates if the charge amount is included in transaction amount as `true` or `false`
balance	Balance info after the transaction
creditDebitIndicator	Indicates whether the balance is a credit or a debit balance
type	Indicator type details
amount	Tag carrying balance amount information
amount	Available amount balance
currency	Currency in which the balance is indicated
merchantDetails	Tag carrying merchant details
merchantName	Name of the merchant
merchantCategoryCode	Assigned merchant category code
merchantId	Unique merchant identification
localTimeZone	Local time zone information
terminalId	Unique terminal identification
chargeAmountVat	Tag carrying VAT amount charges and details
amount	VAT amount charged
currency	Currency of VAT amount charged indicated
flags	Tag carrying flags as array of strings
cardInstrument	Tag carrying card details
cardSchemeName	Scheme name description of the card
instrumentType	Type of instrument used for the card payment
name	Name on the card
identification	Unique card identification
creditorAccount	Tag carrying creditor account information
debtorAccount	Tag carrying debtor account information
identificationType	Type of identification of the account
identification	Account identification details
name	Name of the account holder
transactionInformation	Details of the transaction information
bankTransactionCode	Tag carrying transaction bank codes
domain	Domain details
domainCode	Domain code
family	Domain family details
familyCode	Domain family code
subFamily	Domain sub-family details
subFamilyCode	Domain sub-family code
proprietaryBankTransactionCode	Tag representing proprietary bank transaction code and details
code	Unique proprietary transaction code
issuer	Name of the issuer of the code
creditorAgent	Tag carrying creditor agent information
debtorAgent	Tag carrying debtor agent information
identificationType	Type of identification of the creditor/debtor account
identification	Unique identification details of the creditor/debtor account
postalAddress	Postal address of the creditor/debtor account
addressType	Address type on the creditor/debtor account
streetName	Street name on the creditor/debtor account
buildingNumber	Building number of the creditor/debtor account
postalCode	Postal code on the creditor/debtor
city	City of the creditor/debtor
country	Country of the creditor/debtor
shortAddress	Short address of the creditor/debtor
unitNumber	Unit number of the creditor/debtor
secondaryNumber	Secondary number of the creditor/debtor
district	District of the creditor/debtor
name	Name of the creditor/debtor
billDetails	Tag carrying bill details
billerId	Unique biller identification
billNumber	Bill number
billPaymentType	Payment type for the bill
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages

View All Accounts' Direct Debits

This service requires consentId to return all the direct debits of accounts associated with that consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/allAccountsDirectDebits`	GET

Header

The following headers must be included when calling the Direct Debits API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve direct debits of all accounts

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/allAccountsDirectDebits?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountAggregation=true' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`

Sample response

Example response for a successfully retrieved direct debits of an account

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "directDebit": [
              {
                "directDebitId": "001000000000000000000121",
                "mandateIdentification": "7248812485188",
                "directDebitStatusCode": "Active",
                "name": "SAINSBURYS BANK",
                "previousPaymentDateTime": "2017-11-21T00:00:00.000Z",
                "frequency": "KSAOB.Annual",
                "previousPaymentAmount": {
                  "amount": "269.83",
                  "currency": "SAR"
                }
              }
            ]
          }
        ],
        "currentMonthPaid": {
          "amount": 0,
          "currency": "SAR",
          "count": 0
        }
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and Direct Debits data included in the response
account	Tag carrying information on all the accounts included in the consent
accountId	Unique account identification
accountHolderName	Name of the account holder
accountHolderShortName	Short name of the account holder
status	Status of the account
currency	Default currency of the account
nickname	Nickname of the account
accountType	Details of account type
accountSubType	Details of account sub-type
accountIdentifiers	Tag carrying account identifiers details
identificationType	Account identification type details
identification	Account identification details
name	Name of the account identifier
servicer	Tag carrying account servicer details
identificationType	Servicer identification type details
identification	Servicer identification details
statusUpdateDateTime	Last time and date of update for account information
description	Description of the update
openingDate	Opening date of the account
maturityDate	Maturity date of the account
directDebit	Tag carrying information on Direct Debits for the account
directDebitId	Unique Direct Debit identification
mandateIdentification	Unique mandate identification details
directDebitStatusCode	Status code of the Direct Debit
name	Registered name of the Direct Debit
previousPaymentDateTime	Date and time of the previous Direct Debit payment
frequency	Frequency of the payment
previousPaymentAmount	Amount paid for the last (previous) Direct Debit payment
amount	Transaction amount for the previous direct debit payment
currency	Default currency of the account in which the transaction amount is indicated
currentMonthPaid	Amount paid for the current month's Direct Debit payment
amount	Transaction amount for the previous direct debit payment
currency	Default currency of the account in which the transaction amount is indicated
count	Total count of payments towards the direct debit
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages

View All Accounts' Scheduled Payments

This service requires consentId to return the scheduled payments of all account associated with that consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/allAccountsScheduledPayments`	GET

Header

The following headers must be included when calling the Scheduled Payments API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve scheduled payments of all accounts

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/allAccountsScheduledPayments?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountAggregation=true' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`

Sample response

Example response for a successfully retrieved scheduled payments of all accounts

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "scheduledPayment": [
              {
                "scheduledPaymentId": "001011000000000000000107",
                "scheduledPaymentDateTime": "2020-01-27T05:00:00+00:00",
                "scheduledType": "KSAOB.Arrival",
                "creditorReference": "reference",
                "debtorReference": "debtorReference",
                "instructedAmount": {
                  "amount": "10.00",
                  "currency": "SAR"
                },
                "creditorAgent": {
                  "identificationType": "KSAOB.BICFI",
                  "identification": "identification"
                },
                "creditorAccount": [
                  {
                    "identificationType": "KSAOB.IBAN",
                    "identification": "20304012345678"
                  }
                ]
              }
            ]
          }
        ],
        "currentMonthPaid": {
          "amount": 0,
          "currency": "SAR",
          "count": 0
        }
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying account and Scheduled Payments data included in the response
account	Tag carrying information on all the accounts included in the consent
accountId	Unique account identification
accountHolderName	Name of the account holder
accountHolderShortName	Short name of the account holder
status	Status of the account
currency	Default currency of the account
nickname	Nickname of the account
accountType	Details of account type
accountSubType	Details of account sub-type
accountIdentifiers	Tag carrying account identifiers details
identificationType	Account identification type details
identification	Account identification details
name	Name of the account identifier
servicer	Tag carrying account servicer details
identificationType	Servicer identification type details
identification	Servicer identification details
statusUpdateDateTime	Last time and date of update for account information
description	Description of the update
openingDate	Opening date of the account
maturityDate	Maturity date of the account
scheduledPayment	Tag carrying information on Scheduled Payments of the account
scheduledPaymentId	Unique Scheduled Payment identification
scheduledPaymentDateTime	Date and time of the Scheduled Payment
scheduledPaymentType	Type of the Scheduled Payment
creditorReference	Unique creditor reference details
debtorReference	Unique debtor reference details
instructedAmount	Tag carrying information on the Scheduled Payment instructed amount
amount	Transaction amount of the Scheduled Payment
currency	Default currency in which the Scheduled Payment amount is indicated
creditorAgent	Tag carrying information about creditor agent
identificationType	Type of identification of the creditor
identification	Unique creditor identification details
creditorAccount	Tag carrying information about creditor account
identificationType	Type of identification of the creditor account
identification	Unique creditor account identification details
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages

View All Accounts' Standing Orders

This service requires consentId to return all the standing orders of all account associated with that consent.

Endpoint

Endpoint URL	Method
`/v2/api/observice/allAccountsStandingOrders`	GET

Header

The following headers must be included when calling the Standing Orders API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve standing orders of all account

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/allAccountsStandingOrders?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountAggregation=true' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String
accountAggregation	Mandatory	Specification of data use case API	Enum	`true` or `false`

Sample response

Example response for a successfully retrieved standing orders of all accounts

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "standingOrder": [
              {
                "standingOrderId": "001010000000000000000113",
                "frequency": "WkInMnthDay:02:05",
                "creditorReference": "GSG 10 BANK ROAD",
                "firstPaymentDateTime": "2014-05-15T00:00:00.000Z",
                "nextPaymentDateTime": "2018-01-15T00:00:00.000Z",
                "lastPaymentDateTime": "2020-01-10T00:00:00.000Z",
                "finalPaymentDateTime": "2020-01-10T00:00:00.000Z",
                "numberOfPayments": "3",
                "standingOrderStatusCode": "KSAOB.Active",
                "firstPaymentAmount": {
                  "amount": "84.09",
                  "currency": "SAR"
                },
                "finalPaymentAmount": {
                  "amount": "2.50",
                  "currency": "SAR"
                },
                "supplementaryData": {
                  "supplementary": "data"
                },
                "nextPaymentAmount": {
                  "amount": "84.09",
                  "currency": "SAR"
                },
                "purpose": "Bills and expenses",
                "lastPaymentAmount": {
                  "amount": "10.20",
                  "currency": "SAR"
                },
                "standingOrderType": "KSAOB.LocalBankTransfer",
                "creditorAgent": {
                  "identificationType": "KSAOB.BICFI",
                  "identification": "INDRUK00XXX"
                },
                "creditorAccount": [
                  {
                    "identificationType": "KSAOB.IBAN",
                    "identification": "GB04INDR90872921098674"
                  }
                ]
              }
            ]
          }
        ],
        "currentMonthPaid": {
          "amount": 0,
          "currency": "SAR",
          "count": 0
        }
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and Standing Orders data included in the response
account	Tag carrying information on all the accounts included in the consent
accountId	Unique account identification
accountHolderName	Name of the account holder
accountHolderShortName	Short name of the account holder
status	Status of the account
currency	Default currency of the account
nickname	Nickname of the account
accountType	Details of account type
accountSubType	Details of account sub-type
accountIdentifiers	Tag carrying account identifiers details
identificationType	Account identification type details
identification	Account identification details
name	Name of the account identifier
servicer	Tag carrying account servicer details
identificationType	Servicer identification type details
identification	Servicer identification details
statusUpdateDateTime	Last time and date of update for account information
description	Description of the update
openingDate	Opening date of the account
maturityDate	Maturity date of the account
standingOrder	Tag carrying account's Standing Orders' information
standingOrderId	Unique Standing Order identification
frequency	Frequency of the Standing Order
creditorReference	Unique creditor reference details
firstPaymentDateTime	Date and time of the first standing order payment
nextPaymentDateTime	Date and time of the upcoming standing order payment
lastPaymentDateTime	Date and time of the previous/recent standing order payment
finalPaymentDateTime	Date and time of the final standing order payment
numberOfPayments	Total number of payments from first to final payments
standingOrderStatusCode	Unique status code of the Standing Order
firstPaymentAmount	Tag carrying information on first payment for standing order
amount	Transaction amount of the standing order
currency	Default currency of the account in which the standing order amount is indicated
finalPaymentAmount	Tag carrying information on final payment of standing order
amount	Transaction amount for the standing order
currency	Default currency of the account in which the standing order amount is indicated
supplementaryData	Tag carrying information on supplementary data
supplementary	Supplementary details
nextPaymentAmount	Tag carrying information on the upcoming standing order payment
amount	Transaction amount of the standing order
currency	Default currency in which the standing order amount is indicated
purpose	Details on the purpose of standing order
lastPaymentAmount	Tag carrying information on the previous recent standing order payment
amount	Transaction amount of the standing order
currency	Default currency in which the standing order amount is indicated
standingOrderType	Type of the standing order
creditorAgent	Tag carrying information about creditor agent
identificationType	Type of identification of the creditor
identification	Unique creditor identification details
creditorAccount	Tag carrying information about creditor account
identificationType	Type of identification of the creditor account
identification	Unique creditor account identification details
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Retrieve Aggregated Account Details

Endpoint

Header

Sample request

Sample response

View All Accounts Balance

Endpoint

Header

Sample request

Sample response

View All Accounts Transactions

Endpoint

Header

Sample request

Sample response

View All Accounts' Direct Debits

Endpoint

Header

Sample request

Sample response

View All Accounts' Scheduled Payments

Endpoint

Header

Sample request

Sample response

View All Accounts' Standing Orders

Endpoint

Header

Sample request

Sample response

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Consent information

Retrieve Aggregated Account Details

Endpoint

Header

Sample request

Sample response

View All Accounts Balance

Endpoint

Header

Sample request

Sample response

View All Accounts Transactions

Endpoint

Header

Sample request

Sample response

View All Accounts' Direct Debits

Endpoint

Header

Sample request

Sample response

View All Accounts' Scheduled Payments

Endpoint

Header

Sample request

Sample response

View All Accounts' Standing Orders

Endpoint

Header

Sample request

Sample response