Generate E-Statement

E-Statement service enables you to retrieve account and transaction data across a selected date range and generate a structured electronic statement. This service is commonly used for income verification, financial reporting, lending assessments, auditing, and customer account reviews.

E-Statement provides a detailed record of account activity over a specified period. The response includes account details, transaction history, balance information, and payment-related data that can be used to create digital statements or support financial analysis.

Using this service, you can:

Generate electronic account statements.
Retrieve historical transaction activity.
Analyze account inflows and outflows.
Support lending and affordability assessments.
Verify income and spending behavior.
Build customer-facing statement services.

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 E-Statement service under Data Use Case APIs	`E-STMT`	`"ReadAccountsBasic",` `"ReadAccountsDetail",` `"ReadBalances",` `"ReadTransactionsBasic",` `"ReadTransactionsDetail",` `"ReadTransactionsCredits",` `"ReadTransactionsDebits",`

Scope

useCaseType

Permissions

To access E-Statement service under Data Use Case APIs

E-STMT

"ReadAccountsBasic",

"ReadAccountsDetail",

"ReadBalances",

"ReadTransactionsBasic",

"ReadTransactionsDetail",

"ReadTransactionsCredits",

"ReadTransactionsDebits",

Generate All Accounts Statement

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

Endpoint

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

Header

The following headers must be included when calling the E-Statement API.

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

Sample request

Example to initiate request to retrieve transactions of all accounts for E-Statement

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/eStatements?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&estatement=true&bankCode=SVMOB1&consentId=urn%3ASVMOB%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
estatement	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 all accounts for E-Statement

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "consentId": "urn:SVMOB:kac-d2ee7008-498e-4d9c-99e1-ced98c62a6ac",
      "data": {
        "account": [
          {
            "accountId": "dd11ad81-e172-4121-b6fe-2461a5cfff52",
            "accountHolderName": "Habib Al-Sagga",
            "accountHolderShortName": "Habib Al-Sagga",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Habib Al-Sagga",
            "accountType": "Personal",
            "accountSubType": "",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "00000250000002",
                "name": "Habib Al-Sagga"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-07-11T07:48:38.115Z",
            "description": "Account sub-type description",
            "openingDate": "2022-09-15T07:48:38.115Z",
            "maturityDate": "2024-05-07T07:48:38.115Z",
            "transactions": [
              {
                "transactionId": "5f9c876b-27fa-432d-aa07-1ff6847c0b52",
                "transactionDateTime": "2025-12-07T12:20:00.000Z",
                "transactionReference": "009b07dc-2dab-47a9-bfd9-0cd7384b94c8",
                "transactionType": "KSAOB.SalaryPayment",
                "subTransactionType": "KSAOB.NotApplicable",
                "paymentModes": "KSAOB.Offline",
                "creditDebitIndicator": "KSAOB.Debit",
                "status": "KSAOB.Booked",
                "transactionMutability": "KSAOB.Mutable",
                "bookingDateTime": "2025-12-07T12:20:00.000Z",
                "valueDateTime": "2025-12-07T12:20:00.000Z",
                "amount": {
                  "amount": "149.54",
                  "currency": "SAR"
                },
                "chargeAmount": {
                  "amount": "6.20",
                  "currency": "SAR",
                  "chargeIncluded": false
                },
                "balance": {
                  "creditDebitIndicator": "KSAOB.Credit",
                  "type": "KSAOB.ClosingAvailable",
                  "amount": {
                    "amount": "9038.23",
                    "currency": "SAR"
                  }
                },
                "localTimeZone": "UTC+03:00",
                "terminalId": 11047572,
                "chargeAmountVat": {
                  "amount": "76.39",
                  "currency": "SAR"
                },
                "flags": [
                  "KSAOB.Payroll"
                ],
                "cardInstrument": {
                  "cardSchemeName": "KSAOB.AmericanExpress",
                  "instrumentType": "KSAOB.ApplePay",
                  "name": "test",
                  "identification": "1234********6178"
                },
                "creditorAccount": [
                  {}
                ],
                "debtorAccount": {
                  "identificationType": "KSAOB.IBAN",
                  "identification": "string",
                  "name": "string"
                },
                "transactionInformation": "| E: SAR Acct to USD Wallet                          | E: 2310404126                                      | E:                                                 | E: AUTH:2310404126                                 | E:",
                "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": "postCode",
                    "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": "postCode",
                    "city": "townName",
                    "country": "SA",
                    "shortAddress": "address",
                    "unitNumber": 1234,
                    "secondaryNumber": "1234",
                    "district": "district"
                  },
                  "name": "string"
                },
                "billDetails": {
                  "billerId": 100004,
                  "billNumber": "1234",
                  "billPaymentType": "KSAOB.Renewal"
                }
              }
            ]
          }
        ]
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      },
      "totalAccountsSummary": {}
    }
  ]
}

Response parameters

Parameter	Description
success	Indicates whether the request was successfully processed
payload	Contains account information grouped by bank
code	Bank identifier associated with the account data
data	Contains account details returned from the bank
account	List of accounts associated with the consent
accountId	Unique identifier of the account
accountHolderName	Full name of the account holder
accountHolderShortName	Short or display name of the account holder
status	Current status of the account
currency	Currency in which the account operates
nickname	Nickname assigned to the account
accountType	Specifies the type of accounts that can be accessed
accountSubType	Specifies the type of accounts that can be accessed
accountIdentifiers	Each account may contain one or more identifiers that uniquely identify the account
identificationType	Type of identifier used
identification	Identifier value associated with the account
name	Name associated with the identifier
servicer	This contains information about the financial institution servicing the account
identificationType	Type of bank identifier used
identification	Identifier value of the servicing institution
statusUpdateDateTime	Date and time when the account status was last updated by the servicing bank
description	Additional information or description associated with the account subtype or account characteristics
openingDate	Date and time when the account was originally opened at the bank
maturityDate	Date when the account reaches maturity. This field is typically applicable for term-based accounts.
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
totalAccountsSummary	Information on the accounts included in the statement

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Generate All Accounts Statement

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

Generate All Accounts Statement

Endpoint

Header

Sample request

Sample response