Transaction Enquiry

Retrieve single or multiple bank account transaction details

Overview

Transaction Enquiry is a part of Data API and is accessed to request and retrieve a user's bank account transaction details. There is certain information that is required to pass the request for Transaction enquiry:

📘

Mandatory information

  • The user must provide the valid credentials in the header
    • Valid Access code as "Authorization: Bearer" and Session ID
    • The request should be in the specified format
    • The request should include all the mandatory details with appropriate request tags

Sample Transaction Enquiry request

A Transaction enquiry request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/transaction.

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/osvPlatform/transaction' \
--header 'clientId: Enter_Client_Id' \
--header 'clientCode: Enter_Client_Code' \
--header 'signature: Enter_Signature' \
--header 'sid: Enter_Session_ID' \
--header 'Authorization: Bearer Enter_Access_Token' \
--header 'Content-Type: application/json' \
--header 'Cookie: _redisPractice=s%3Aiqp4yTRCjCsqTNphd2OuSP1zIysw7Kwu.4R%2BHVD8jJ07Q89cC4ZqxyO8I7InfA6KH9DF9TYqZ%2FsY' \
--data-raw '{
  "osvPlatformTransactionRQ": {
    "userName":"Enter_Username",
    "fromDate": "Enter_YYYY-MM-DDT00:00:00",
    "toDate": "Enter_YYYY-MM-DDTHH:MM:SS",
    "transactionType": "940",
    "osvPlatformBanks": [
      {
        "bankCode": "Bank_Name",
        "companyCode": "Enter_Company_Code",
        "b2bIdentifier": "Enter_B2B_Identifier",
        "b2bUserId": "Enter_B2B_User_ID",
        "b2bUrn": "Enter_B2B_URN",
        "b2bAggrId": "Enter_B2B_Aggregate_ID",
        "accountNumbers": [
          Account_Number_1,
          Account_Number_2
        ]
      }
    ]
  }
}'

Request description:

JSON TagDescriptionData type
clientId
Mandatory
Client IDString
clientCode
Mandatory
Client CodeString
signature
Mandatory
SignatureString
sid
Mandatory
Session IDString
Authorization: Bearer
Mandatory
Authorization Bearer Code i.e., Access TokenString
osvPlatformTransactionRQ
Mandatory
Transaction Enquiry Request TagObject
userName
Mandatory
Account UsernameString
fromDate
Mandatory
Transactions from the set dateString
toDate
Mandatory
Transactions till the set dateString
transactionType
Mandatory
Type of transactions (Filter)String
osvPlatformBanks
Mandatory
Array of BanksArray
bankCode
Mandatory
Bank Code as per Bank NameString
companyCode
Mandatory
Company CodeString
b2bIdentifier
Optional
B2B Identifier details with respect to BankString
b2bUserId
Optional
B2B User ID details with respect to BankString
b2bUrn
Optional
B2B URN details with respect to BankString
b2bAggrId
Optional
B2B Aggregate ID details with respect to BankString
accountNumbers
Mandatory
Array of Account NumbersArray
Account_Number_1
Account_Number_2
Account_Number_3
Mandatory
List of Bank Account NumbersString

Sample responses

Valid/Successful response

✔️ If Valid information in the header and body of a request is processed successfully

{
  "osvPlatformTransactionRS": {
    "status": "SUCCESS",
    "osvPlatformBanks": [
      {
        "status": "SUCCESS",
        "statusCode": "OK",
        "statusDetail": "Response_Message",
        "bankCode": "Bank_Code",
        "companyCode": "Company_Code",
        "bankOpeningBalance": 0000.00,
        "bankClosingBalance": 0000.00,
        "bankAccounts": [
          {
            "accountNo": "Account_Number_1",
            "transactionDetails": [
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
                "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              },
              {
               "valueDate": "YYMMDD",
                "entryDate": "MMDD",
                "dcMark": "D",
                "fundsCode": "Funds_Code",
                "amount": 0000.00,
                "transactionType": "Transaction_Type",
                "identificationCode": "Identification_Code",
                "accountOwnerReference": "Account_Owner_Reference",
                "bankReference": "Bank_Reference",
                "description": "Description"
              }
            ]
          }
        ]
      }
    ]
  }
}

Valid/Successful response description:

JSON TagDescriptionData type
osvPlatformTransactionRSTransaction Enquiry Response TagObject
statusStatus of the processString
osvPlatformBanksArray of BanksArray
statusCodeProcess Status CodeString
statusDetailProcess Status DetailsString
bankCodeBank CodeString
companyCodeCompany CodeString
bankOpeningBalanceOpening Bank Balances - CumulativeNumerical
bankClosingBalanceClosing Bank Balances - CumulativeNumerical
bankAccountsArray of Bank AccountsArray
accountNoBank Account NumberString
transactionDetailsDetails of the available transactionsArray
valueDateDate of the transaction performedString
entryDateDate of transaction settlementString
dcMarkDC MarkString
fundsCodeFunds CodeString
amountTransaction AmountString
transactionTypeTransaction TypeString
identificationCodeIdentification CodeString
accountOwnerReferenceAccount Owner Reference NumberString
bankReferenceBank Reference NumberString
descriptionDescription of TransactionString

Invalid/Failed response

❌ If Invalid information in the header of a request is processed successfully

{
        status: "FAILURE",
        errorCode: "Failed_Code",
        message: "Failed_Message"
      }

Invalid/failed response description:

JSON TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString

Response in case of a Technical error is encountered

⚠️ When the process encounters a technical error

{
        status: "TECHERROR",
        errorCode: "Error_Code",
        message: "Error_Message"
      }

Error response description:

JSON TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString