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
Get Transactions
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/osvPlatform/transaction | POST | 1. clientId 2. clientCode 3. signature 4. sid 5. Authorization: Bearer |
Sample 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 Tag | Description | Data type |
|---|---|---|
| clientId Mandatory | Client ID | String |
| clientCode Mandatory | Client Code | String |
| signature Mandatory | Signature | String |
| sid Mandatory | Session ID | String |
| Authorization: Bearer Mandatory | Authorization Bearer Code i.e., Access Token | String |
| osvPlatformTransactionRQ Mandatory | Transaction Enquiry Request Tag | Object |
| userName Mandatory | Account Username | String |
| fromDate Mandatory | Transactions from the set date | String |
| toDate Mandatory | Transactions till the set date | String |
| transactionType Mandatory | Type of transactions (Filter) | String |
| osvPlatformBanks Mandatory | Array of Banks | Array |
| bankCode Mandatory | Bank Code as per Bank Name | String |
| companyCode Mandatory | Company Code | String |
| b2bIdentifier Optional | B2B Identifier details with respect to Bank | String |
| b2bUserId Optional | B2B User ID details with respect to Bank | String |
| b2bUrn Optional | B2B URN details with respect to Bank | String |
| b2bAggrId Optional | B2B Aggregate ID details with respect to Bank | String |
| accountNumbers Mandatory | Array of Account Numbers | Array |
| Account_Number_1 Account_Number_2 Account_Number_3 Mandatory | List of Bank Account Numbers | String |
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 Tag | Description | Data type |
|---|---|---|
| osvPlatformTransactionRS | Transaction Enquiry Response Tag | Object |
| status | Status of the process | String |
| osvPlatformBanks | Array of Banks | Array |
| statusCode | Process Status Code | String |
| statusDetail | Process Status Details | String |
| bankCode | Bank Code | String |
| companyCode | Company Code | String |
| bankOpeningBalance | Opening Bank Balances - Cumulative | Numerical |
| bankClosingBalance | Closing Bank Balances - Cumulative | Numerical |
| bankAccounts | Array of Bank Accounts | Array |
| accountNo | Bank Account Number | String |
| transactionDetails | Details of the available transactions | Array |
| valueDate | Date of the transaction performed | String |
| entryDate | Date of transaction settlement | String |
| dcMark | DC Mark | String |
| fundsCode | Funds Code | String |
| amount | Transaction Amount | String |
| transactionType | Transaction Type | String |
| identificationCode | Identification Code | String |
| accountOwnerReference | Account Owner Reference Number | String |
| bankReference | Bank Reference Number | String |
| description | Description of Transaction | String |
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 Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
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 Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
Updated 7 months ago