Transactions

Get Account Transactions

Singleview Open Banking AIS API retrieves the transactions resource for a specific or multiple accounts 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
1750

Singleview Open Banking - Representation of process to fetch account transaction through AIS

Endpoint details

EndpointMethodGrant typeScope
/v1/api/openBanking/aisp/accountsTransactionPOSTThe header should include:
1. clientId
2. clientCode
3. signature
4. sid
5. Authorization: Bearer
Fetch single or multiple accounts' transaction details using account IDs

Request to get transaction details

{
                    "SVTransByIdRequest": {
                      "DateTimeStamp": "2022-03-29T17:51:03",
                      "RequestID": "SDFSDFF23424234244",
                      "userName": "tatanew",
                      "SVTransInfoMessage": [
                        {
                          "SVTransInfoRequest": {
                            "BankCode": "ANB",
                            "Account_Id":"82a4ab46-bb56-42fb-a1d0-a5f6c5b58e5e",
                            "ConsentId": "bd52fa99-4398-472e-97b3-7279c2e886d5"
                          }
                        },
                        {
                          "SVTransInfoRequest": {
                            "BankCode": "ALRAJHI",
                            "Account_Id":"82a4ab46-bb56-42fb-a1d0-a5f6c5b58e5e"
                          }
                        }
                      ]
                    }
                  }

Description:

JSON tagDescriptionData type
SVTransByIdRequest
Mandatory
Get transaction details by account ID request tagObject
DateTimeStamp
Mandatory
Stamp denoting the request date and timeString
RequestID
Mandatory
Unique request identificationString
userName
Mandatory
Client UsernameString
SVTransInfoMessage
Mandatory
Get transactions information message tagObject
SVTransInfoRequest
Mandatory
Requested specific account transaction information tagArray
BankCode
Mandatory
Unique bank code for identificationString
AccountId
Mandatory
Unique identifier for the account resourceString
ConsentId
Mandatory
Unique consent identificationString

Successfully fetched transaction response - sample

{
  "SVTransByIdResponse": {
    "DateTimeStamp": "2022-03-29T17:51:03",
    "SVTransInfoMessage": [
      {
        "SVTransInfoResponse": {
          "BankCode": "NCB",
          "Data": {
            "Transaction": [
              {
                "AccountId": "74d69a05-0381-4767-bd9b-824fd9714875",
                "BookingDateTime": "2022-05-10T15:14:36.000Z",
                "CreditDebitIndicator": "Credit",
                "Status": "Booked",
                "TransactionId": "SDC278494",
                "ValueDateTime": "2022-05-10",
                "Amount": {
                  "Amount": 404.00,
                  "Currency": "SAR"
                },
                "BankTransactionCode": {},
                "CardInstrument": {
                  "AuthorisationType": "None",
                  "CardSchemeName": "MADA",
                  "Identification": "9045784824-Payment to merchantB2B OUTGOING - 16521848751652184875",
                  "Name": "card name"
                },
                "ChargeAmount": {
                  "Amount": 404.00,
                  "Currency": "SAR"
                },
                "CurrencyExchange": {
                  "TargetCurrency": "SAR",
                  "SourceCurrency": "SAR"
                },
                "ProprietaryBankTransactionCode": {
                  "Code": "030"
                }
              },
              {
                "AccountId": "74d69a05-0381-4767-bd9b-824fd9714875",
                "BookingDateTime": "2022-05-10T15:18:48.000Z",
                "CreditDebitIndicator": "Debit",
                "Status": "Booked",
                "TransactionId": "SDC278497",
                "ValueDateTime": "2022-05-10",
                "Amount": {
                  "Amount": -0.59,
                  "Currency": "SAR"
                },
                "BankTransactionCode": {},
                "CardInstrument": {
                  "AuthorisationType": "None",
                  "CardSchemeName": "MADA",
                  "Identification": "6034215896-تحويل بين حساباتيFX_FROM 4768ed361652185123773707",
                  "Name": "card name"
                },
                "ChargeAmount": {
                  "Amount": -0.59,
                  "Currency": "SAR"
                },
                "CurrencyExchange": {
                  "TargetCurrency": "SAR",
                  "SourceCurrency": "SAR"
                },
                "ProprietaryBankTransactionCode": {
                  "Code": "030"
                }
              }
            ]
          },
          "Links": {
            "Self": "www.developer.anb.com.sa"
          },
          "Meta": {
            "TotalPages": 1,
            "IsCompleted": true,
            "FirstAvailableDateTime": "2022-05-10",
            "LastAvailableDateTime": "2022-05-11",
            "ItemCount": 2
          }
        }
      },
      {
        "SVTransInfoResponse": {
          "BankCode": "ALRAJHI",
          "Data": {
            "Transaction": [
              {
                "AccountId": "74d69a05-0381-4767-bd9b-824fd9714875",
                "BookingDateTime": "2022-05-10T15:14:36.000Z",
                "CreditDebitIndicator": "Credit",
                "Status": "Booked",
                "TransactionId": "SDC278494",
                "ValueDateTime": "2022-05-10",
                "Amount": {
                  "Amount": 404.00,
                  "Currency": "SAR"
                },
                "BankTransactionCode": {},
                "CardInstrument": {
                  "AuthorisationType": "None",
                  "CardSchemeName": "MADA",
                  "Identification": "9045784824-Payment to merchantB2B OUTGOING - 16521848751652184875",
                  "Name": "card name"
                },
                "ChargeAmount": {
                  "Amount": 404.00,
                  "Currency": "SAR"
                },
                "CurrencyExchange": {
                  "TargetCurrency": "SAR",
                  "SourceCurrency": "SAR"
                },
                "ProprietaryBankTransactionCode": {
                  "Code": "030"
                }
              },
              {
                "AccountId": "74d69a05-0381-4767-bd9b-824fd9714875",
                "BookingDateTime": "2022-05-10T15:18:48.000Z",
                "CreditDebitIndicator": "Debit",
                "Status": "Booked",
                "TransactionId": "SDC278497",
                "ValueDateTime": "2022-05-10",
                "Amount": {
                  "Amount": -0.59,
                  "Currency": "SAR"
                },
                "BankTransactionCode": {},
                "CardInstrument": {
                  "AuthorisationType": "None",
                  "CardSchemeName": "MADA",
                  "Identification": "6034215896-تحويل بين حساباتيFX_FROM 4768ed361652185123773707",
                  "Name": "card name"
                },
                "ChargeAmount": {
                  "Amount": -0.59,
                  "Currency": "SAR"
                },
                "CurrencyExchange": {
                  "TargetCurrency": "SAR",
                  "SourceCurrency": "SAR"
                },
                "ProprietaryBankTransactionCode": {
                  "Code": "030"
                }
              }
            ]
          },
          "Links": {
            "Self": "www.developer.anb.com.sa"
          },
          "Meta": {
            "TotalPages": 1,
            "IsCompleted": true,
            "FirstAvailableDateTime": "2022-05-10",
            "LastAvailableDateTime": "2022-05-11",
            "ItemCount": 2
          }
        }
      }
    ]
  }
}

Response Description

JSON tagDescription
successProcess success status represented as True or False
messageProcess execution message
SVTransByIdResponseGet transactions by account IDs response tag
DateTimeStampStamp denoting the response date and time
SVTransInfoMessageGet transactions information message tag
SVTransInfoResponseFetched transaction specific information tag
DataData tag for transaction information
TransactionTransaction details tag
AccountIdUnique identifier for the account resource
BookingDateTimeDate and time denoting the transaction entry to an account
CreditDebitIndicatorIndicates if the balance is a credit or a debit balance
StatusIndicates the current state of the transaction
TransactionIdUnique identifier for transaction resource
ValueDateTimeDate of transaction settlement or execution
AmountTransaction amount
CurrencyIdentification of the currency reflected for the account
BankTransactionCodeTransaction code issued by the bank
CardInstrumentCategory code of the transaction performed by card
AuthorisationTypeDetails on type of authorization
CardSchemeNameName of the card's identification scheme
IdentificationUnique identification of the servicing institution
NameName of the card owner
chargeAmountTotal amount charged
CurrencyExchangeRate of currency exchange
TargetCurrencyTransaction exchanged to currency
SourceCurrencyTransaction base currency
ProprietaryBankTransactionCodeBank's transaction code
CodeUnique bank code
LinksRedirect links
SelfOwn link/url details
MetaMeta tag
TotalPagesInformation on number of pages
IsCompletedStatus of the transaction fetching process represented as true or false
FirstAvailableDateTimeDate of first transaction fetched in response
LastAvailableDateTimeDate of the last transaction fetched in response
ItemCountNumber of total transactions shown or listed