Account Statement
Retrieve single or multiple bank account balances
SingleView B2B API services Account statement allows users access to request and retrieve specific user bank account statements. Corporate Customers can use this B2B service to get unaltered and raw account statement information, including all the majorly required information.
Mandatory information
- The user must provide the valid credentials in the header
- Encrypted and valid Signature and an active "Access Token."
- Request format as specified with all the mandatory details with appropriate request tags
πDomain details
- Sandbox API - https://sandboxapi.onesingleview.com
- Production/LIVE API - To be provided upon onboarding
Get Account Statement
Endpoint details
Endpoint URL | Method | Grant type |
---|---|---|
/api/v1/account/statement/940 | POST | 1. clientsecret 2. clientid 3. SVReferenceID 4. CompanyID 5. BaseCurrency 6. Authorization: Bearer 7. Signature |
Sample request
curl --location 'https://sandboxapi.onesingleview.com/api/v1/account/statement/940' \
--header 'clientsecret: Enter-Client-Secret' \
--header 'clientid: Enter-Client-Id' \
--header 'SVReferenceID: Enter-SV-Reference-Id' \
--header 'Device: Device-type' \
--header 'DateTimeStamp: YYYY-MM-DDTHH:MM:SS' \
--header 'CompanyId: Enter-Company-Id' \
--header 'BaseCurrency: SAR' \
--header 'Authorization: Bearer <Enter-Token>' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
"OSVAccountStatementRequest": {
"FromDate": "YYYY-MM-DDTHH:MM:SS",
"ToDate": "YYYY-MM-DDTHH:MM:SS",
"DateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
"TransactionType": "Enter_Transaction_Type",
"OSVPaymentInfoMessage": [
{
"OSVPaymentInfoRequest": {
"BankCode": "Enter_Bank_Code",
"CompanyCode": "Enter_Company_Code",
"AccountNumbers": {
"AccountNumber": [
{
"AccNumber": "Account_Number"
}
]
}
}
}
]
}
},
"Signature": "Enter_Signature_String"
}'
Request description:
JSON Tag | Description | Data type |
---|---|---|
Message Mandatory | Header information (client credentials) | Object & String |
OSVAccountStatementRequest Mandatory | Root node | Object |
FromDate Mandatory | From date | String |
ToDate Mandatory | To date | String |
DateTimeStamp Mandatory | Enquiry Date | String |
TransactionType Mandatory | Always it should be β940β | String |
OSVPaymentInfoMessage Mandatory | This tag contains multiple banks requests | Object |
OSVPaymentInfoRequest Mandatory | Element root | Object |
BankCode Mandatory | Name of the bank. Ex: βALRAJHIβ, βSABBβ | String |
CompanyCode Mandatory | Sender company code/Identifier provided by the bank during on-boarding | String |
AccountNumbers Mandatory | Array of accounts | Array of Strings |
AccountNumber Mandatory | Bank account number | String |
AccNumber Mandatory | Unique account number for which the account statement is requested | String |
Signature Mandatory | Encrypted string obtained by processing request body with Private Key/Certificate through SHA-256 with RSA Algorithm (Crypto : JCE Sign) | String |
Sample responses
{
"OSVAccoutStatementResponse": {
"FromDate": "YYYY-MM-DDTHH:MM:SS",
"ToDate": "YYYY-MM-DDTHH:MM:SS",
"TransactionType": "940",
"OSVPaymentInfoMessageResponse": [
{
"BankCode": "ANB",
"CompanyCode": "Jazeera",
"B2BUrn": "",
"B2BAggrId": "",
"B2BUserId": "",
"StatusCode": "OK",
"StatusDetail": "OK",
"ResponseItemCount": "",
"TotalOpeningBalance": 491959149.42,
"TotalOpeningBalanceUSD": 0,
"TotalOpeningBalanceAED": 0,
"TotalOpeningBalanceGBP": 0,
"TotalOpeningBalanceINR": 0,
"TotalOpeningBalanceKWD": 0,
"TotalOpeningBalanceBHD": 0,
"TotalOpeningBalanceEUR": 0,
"TotalClosingBalance": 491959795.67,
"TotalClosingBalanceUSD": 0,
"TotalClosingBalanceAED": 0,
"TotalClosingBalanceGBP": 0,
"TotalClosingBalanceINR": 0,
"TotalClosingBalanceKWD": 0,
"TotalClosingBalanceBHD": 0,
"TotalClosingBalanceEUR": 0,
"OSVPaymentInfoResponse": [
{
"StatusCode": "OK",
"StatusDetail": "OK",
"TransactionType": "940",
"SequenceNum": "",
"AccountNumber": "Account_Number",
"ReceiptTime": "",
"ProcessStatus": "",
"TransactionData": {
"UniqueReference": "",
"RelatedReferenceNumber": "",
"AccountNumber": "Account_Number",
"StatementNo": "",
"TransactionTime": "",
"CurrencyAmountCode": "",
"OpeningBalance": {
"DCMark": "",
"Date": "",
"Currency": "SAR",
"Amount": 491959149.42
},
"TransactionDetails": [
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
},
{
"ValueDate": "230212",
"EntryDate": "0212",
"PostingTime": "",
"DCMark": "C",
"FundsCode": "",
"Amount": 50,
"TransactionType": "56",
"IdentificationCode": "",
"AccountOwnerReference": "Account_Owner_Reference",
"BankReference": "Bank_Reference",
"Description": "Description",
"SourceAccount": "Source_Account",
"SourceID": "",
"SourceAccountName": "Source_Account_Name",
"CardType": "",
"BillerId": "",
"Category": "Local Transfer",
"VirtualAccount": ""
}
],
"ClosingBalance": {
"DCMark": "",
"Date": "",
"Currency": "SAR",
"Amount": 491959795.67
},
"ClosingAvailableBalance": {
"DCMark": "",
"Date": "",
"Currency": "",
"Amount": ""
},
"Comment": "",
"TotalNumberOfDebits": "",
"TotalNumberOfCredits": ""
}
}
]
}
]
}
}
{
"OSVAccoutStatementResponse": {
"FromDate": "YYYY-MM-DDTHH:MM:SS",
"ToDate": "YYYY-MM-DDTHH:MM:SS",
"TransactionType": "940",
"OSVPaymentInfoMessageResponse": [
{
"BankCode": "NCB",
"CompanyCode": "ABC1234",
"B2BUrn": "",
"B2BAggrId": "",
"B2BUserId": "",
"StatusCode": "Failed",
"StatusDetail": "Failed",
"ResponseItemCount": "1",
"TotalOpeningBalance": "",
"TotalOpeningBalanceUSD": "",
"TotalOpeningBalanceAED": "",
"TotalOpeningBalanceGBP": "",
"TotalOpeningBalanceINR": "",
"TotalOpeningBalanceKWD": "",
"TotalOpeningBalanceBHD": "",
"TotalOpeningBalanceEUR": "",
"TotalClosingBalance": "",
"TotalClosingBalanceUSD": "",
"TotalClosingBalanceAED": "",
"TotalClosingBalanceGBP": "",
"TotalClosingBalanceINR": "",
"TotalClosingBalanceKWD": "",
"TotalClosingBalanceBHD": "",
"TotalClosingBalanceEUR": "",
"OSVPaymentInfoResponse": [
{
"StatusCode": "Failed",
"StatusDetail": "Unauthorized to access the service",
"TransactionType": "940",
"SequenceNum": "",
"AccountNumber": "Account_Number",
"ReceiptTime": "",
"ProcessStatus": "",
"TransactionData": {
"UniqueReference": "",
"RelatedReferenceNumber": "",
"AccountNumber": "Account_Number",
"StatementNo": "",
"TransactionTime": "",
"CurrencyAmountCode": "",
"OpeningBalance": {
"DCMark": "",
"Date": "",
"Currency": "",
"Amount": ""
},
"TransactionDetails": [],
"ClosingBalance": {
"DCMark": "",
"Date": "",
"Currency": "",
"Amount": ""
},
"ClosingAvailableBalance": {
"DCMark": "",
"Date": "",
"Currency": "",
"Amount": ""
},
"Comment": "",
"TotalNumberOfDebits": "",
"TotalNumberOfCredits": ""
}
}
]
}
]
}
}
Response description
JSON Tag | Description | Data type |
---|---|---|
OSVAccoutStatementResponse | Root node | Object |
FromDate | From Date | String |
ToDate | To Date | String |
TransactionType | Always it should be β940β | String |
OSVPaymentInfoMessageResponse | Element root containing response of every bank | Object |
BankCode | Name of the bank Ex: βALRAJHIβ, βSABBβ | String |
CompanyCode | Sender company code/Identifier provided by the bank during on-boarding | String |
B2BUrn | Unique B2B reference number | String |
B2BAggrId | Unique B2B aggregator identification details | String |
B2BUserId | Unique B2B user identification details | String |
StatusCode | Status code of the processed request | String |
StatusDetail | Status details of the processed request | String |
ResponseItemCount | Number of transactions included in the statement | String |
TotalOpeningBalance | Total Opening Balance | String |
TotalOpeningBalanceUSD | Total Opening Balance in USD | |
TotalOpeningBalanceAED | Total Opening Balance in AED | |
TotalOpeningBalanceGBP | Total Opening Balance in GBP | |
TotalOpeningBalanceINR | Total Opening Balance in INR | |
TotalOpeningBalanceKWD | Total Opening Balance in KWD | |
TotalOpeningBalanceBHD | Total Opening Balance in BHD | |
TotalOpeningBalanceEUR | Total Opening Balance in EUR | |
TotalClosingBalance | Total Closing Balance | String |
TotalClosingBalanceUSD | Total Closing Balance in USD | |
TotalClosingBalanceAED | Total Closing Balance in AED | |
TotalClosingBalanceGBP | Total Closing Balance in GBP | |
TotalClosingBalanceINR | Total Closing Balance in INR | |
TotalClosingBalanceKWD | Total Closing Balance in KWD | |
TotalClosingBalanceBHD | Total Closing Balance in BHD | |
TotalClosingBalanceEUR | Total Closing Balance in EUR | |
OSVPaymentInfoResponse | This tag contains the status of the Bank Accounts | Object |
TransactionType | Type of transaction | String |
StatusCode | Status code of the transaction | Boolean |
StatusDetail | Status details of the transaction | Boolean |
SequenceNum | Unique sequence number of the transaction | String |
AccountNumber | Account Number | String |
ReceiptTime | Receipt Time of the Enquiry | String |
ProcessStatus | Status of the process | String |
TransactionData | Tag carrying information on transaction details | String |
UniqueReference | Statement reference number | String |
RelatedReferenceNumber | Concerned related reference number | String |
AccountNumber | Account Number | String |
StatementNo | Statement Number | String |
CurrencyAmountCode | Code of the currency | String |
OpeningBalance | Tag carrying information on opening balance | String |
DCMark | Credit/Debit mark | String |
Date | Date of the credit and debit amount | String |
Currency | Account Currency. Maximum length of Currency should be 3. E.g. SAR | String |
Amount | Amount | String |
TransactionDetails | Tag carrying information on transaction details | String |
ValueDate | Date at which transaction is valued | String |
EntryDate | Date at which transaction is entered in the statememt | String |
PostingTime | Time of posting of the transaction status | String |
DCMark | Transaction Credit/Debit | String |
FundsCode | Code of the funds | String |
Amount | Credit/Debit Amount | String |
TransactionType | S: Swift Transfer N: Non Swift Transfer F: First Advice | String |
IdentificationCode | Unique identification code | String |
AccountOwnerReference | Account Owner Reference Number | String |
BankReference | Bank Reference Number | String |
Description | Transaction Description | String |
SourceAccount | Source Account | String |
SourceID | Source ID | String |
SourceAccountName | Source Account Name | String |
CardType | Card Type | String |
BillerId | Unique SADAD biller identification details | String |
Category | Category of the transaction among Local Transfer , POS , BANK COMMISION , ATM | String |
VirtualAccount | Unique virtual account identification details | String |
ClosingBalance | Tag carrying information on closing balance | Object |
DCMark | DC mark of the closing balance | String |
Date | Date of the indicated closing balance | String |
Currency | Currency of the closing balance displayed | String |
Amount | Amount denoting the closing balance | Numerical |
ClosingAvailableBalance | Tag carrying information on available closing balance | Object |
DCMark | DC mark of the available closing balance | String |
Date | Date of the indicated available closing balance | String |
Currency | Currency of the closing available balance displayed | String |
Amount | Amount denoting the available closing balance | Numerical |
Comment | Comment for the process | String |
TotalNumberOfDebits | Number of debits included in the statement | Numerical |
TotalNumberOfCredits | Number of credits included in the statement | Numerical |
Updated 2 months ago