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


View transactions

Retrieve transaction history for a customer account, including transaction amounts, dates, payment details, balances, and additional transaction metadata

Transactions API provides access to customer-permissioned transaction data through the Open Banking framework. Transaction information can be used to support account monitoring, income and expense analysis, financial reporting, customer verification, and other financial services.

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

Consent information

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 all AIS API services:

  • Accounts
  • Balances
  • Transactions
  • Parties
  • Standing Orders
  • Scheduled Payments
  • Direct Debits

AISP

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

"ReadBeneficiariesBasic", 

"ReadBeneficiariesDetail", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

"ReadScheduledPaymentsBasic", 

"ReadScheduledPaymentsDetail", 

"ReadDirectDebits", 

"ReadStandingOrdersBasic", 

"ReadStandingOrdersDetail"

View All Accounts Transactions

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

Endpoint

Endpoint URL

Method

/v2/api/observice/transactionsById

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 transactions of an account
curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/transactionsById?dateTimeStamp=2023-06-14T17%3A51%3A03&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountId=100004000000000000000001' \
     --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

 

accountId

Mandatrory

Unique identifier of the bank account associated with the consent

String

 

Sample response

Example response for a successfully retrieved transactions of an account
{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "accountId": "100004000000000000000001",
        "transaction": [
          {
            "transactionId": "054724b4-9974-40bf-a406-96aefd2158c7",
            "transactionDateTime": "2025-11-13T15:51:00.000Z",
            "transactionReference": "2c1ae342-c32a-4562-afb2-b0824a4af9d3",
            "transactionType": "KSAOB.CashDeposit",
            "subTransactionType": "KSAOB.NotApplicable",
            "paymentModes": "KSAOB.Offline",
            "creditDebitIndicator": "KSAOB.Debit",
            "status": "KSAOB.Booked",
            "transactionMutability": "KSAOB.Mutable",
            "bookingDateTime": "2025-11-13T15:51:00.000Z",
            "valueDateTime": "2025-11-13T15:51:00.000Z",
            "amount": {
              "amount": "75.27",
              "currency": "SAR"
            },
            "chargeAmount": {
              "amount": "6.20",
              "currency": "SAR",
              "chargeIncluded": false
            },
            "balance": {
              "creditDebitIndicator": "KSAOB.Credit",
              "type": "KSAOB.ClosingAvailable",
              "amount": {
                "amount": "7904.16",
                "currency": "SAR"
              }
            },
            "localTimeZone": "UTC+03:00",
            "terminalId": 63853416,
            "chargeAmountVat": {
              "amount": "95.24",
              "currency": "SAR"
            },
            "flags": [
              "KSAOB.Payroll"
            ],
            "cardInstrument": {
              "cardSchemeName": "KSAOB.AmericanExpress",
              "instrumentType": "KSAOB.ApplePay",
              "name": "test",
              "identification": "1234********6685"
            },
            "creditorAccount": [
              {}
            ],
            "debtorAccount": {
              "identificationType": "KSAOB.IBAN",
              "identification": "string",
              "name": "string"
            },
            "transactionInformation": "PURCHASE /ELC-062-ELECTRONIC SERVICES - RIYADH/ Trans DateTime:20-11-2023 23:11/ Tran Ref:0300078356/ Visa / 01919240/ Merchant:AL HILAL MULTISPECIALTY M  / MANAMA  / BAHRAIN/ Acquirer Ref:000823  /3.5 BHD  /35.86 SAR @ 10.25 /Charges:0 SAR /Due Date:20-11-2023",
            "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": "https://rs-ob-sb.SVMB01.com/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/transactions"
      },
      "meta": {
        "totalPages": 11
		}
    }
  ]
}

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

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

Updated July 2, 2026

Was this helpful?