Overview

Singleview Payment API can be used to retrieve Payroll payment details by using the Payment Enquiry option. Transaction number along with other information need to be included in the request body. These details are processed by the system and the payment details will be provided based on the validity of the request information.

📘
Post info
A Payroll Payment Enquiry request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/payrollPaymentEnquiry.

Sample request

A Payment Enquiry request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/paymentEnquiry.

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/osvPlatform/payrollPaymentEnquiry' \
--header 'clientId: Enter_Client_ID' \
--header 'clientCode: Enter_Client_Code' \
--header 'Content-Type: application/json' \
--header 'Cookie: _redisPractice=s%3Ay4kF1GA_ibdpeffd7FkfQuOqTXeToD9a.Y5zI1Y3FPImLmHSIy2dUpPrJ47vFGBD7tj7Vv0ndYo4' \
--data-raw '{
  "osvPlatformPayrollPaymentEnquiryRQ": {
    "userName": "Enter_Username",
    "osvPlatformBanks": [
      {
        "bankCode": "Enter_Bank_Code",
        "messageType": "Enter_Message_Type",
        "osvPlatformTransactions": [
          {
            "companyCode": "Enter_Company_Code",
            "transactionReferenceNumber": "Enter_Transaction_Reference_Number",
            "messageDescription": "Enter_Message_Description",
            "debitAccountNumber": "Enter_Debit_Account_Number",
            "date": "Enter_Date_as_YYYY-MM-DD",
            "fileSeqNo": "MMNN"
          },
          {
            "companyCode": "Enter_Company_Code",
            "transactionReferenceNumber": "Enter_Transaction_Reference_Number",
            "messageDescription": "Enter_Message_Description",
            "debitAccountNumber": "Enter_Debit_Account_Number",
            "date": "Enter_Date_as_YYYY-MM-DD",
            "fileSeqNo": "MMNN"
          }
        ]
      }
    ]
  }
}'

Request description:

JSON Tag	Description	Data type
clientId Mandatory	Client ID	String
clientCode Mandatory	Client Code	String
osvPlatformPayrollPaymentEnquiryRQ Mandatory	Payroll Payment Enquiry Request Tag	Object
userName Mandatory	Account Username	String
osvPlatformBanks Mandatory	Array of Banks	Array
bankCode Mandatory	Bank Code as per Bank Name	String
messageType Mandatory	Type of payment	String
osvPlatformTransactions Mandatory	Array of Transactions	Array
companyCode Mandatory	Company Code	String
transactionReferenceNumber Mandatory	Transaction Reference Number of the payment	String
messageDescription Mandatory	Description message	String
debitAccountNumber Mandatory	Debit account number	String
date Mandatory	Scheduled or due date of the payment	String
fileSeqNo Mandatory	File sequence number	String

Sample responses

Valid/Successful response

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

{
  "osvPlatformPayrollPaymentEnquiryRS": {
    "osvPlatformBanks": [
      {
        "bankCode": "Bank_Code",
        "messageType": "Message",
        "osvPlatformTransactions": [
          {
            "companyCode": "Company_Code",
            "sequenceNum": "Sequence_Number",
            "transactionReferenceNumber": "Transaction_Reference_Number",
            "messageType": "Message",
            "messageDescription": "Description",
            "transferType": "Transfer_Type",
            "payrollTransactionAmount": 00.00,
            "transactionDate": "YYYY-MM-DD",
            "totalTransactionCount": 00,
            "grossAmount": 00.00,
            "valueDate": "YYYY-MM-DD",
            "fileSeqNo": "MMNN",
            "orderingCustomerAccountNumber": "Account_Number",
            "orderingCustomerName": "Name",
            "statusCode": "Code",
            "statusDesc": "Description"
          },
          {
            "companyCode": "Company_Code",
            "sequenceNum": "Sequence_Number",
            "transactionReferenceNumber": "Transaction_Reference_Number",
            "messageType": "Message",
            "messageDescription": "Description",
            "transferType": "Transfer_Type",
            "payrollTransactionAmount": 00.00,
            "transactionDate": "YYYY-MM-DD",
            "totalTransactionCount": 00,
            "grossAmount": 00.00,
            "valueDate": "YYYY-MM-DD",
            "fileSeqNo": "MMNN",
            "orderingCustomerAccountNumber": "Account_Number",
            "orderingCustomerName": "Name",
            "statusCode": "Code",
            "statusDesc": "Description"
          },
          {
            "companyCode": "Company_Code",
            "sequenceNum": "Sequence_Number",
            "transactionReferenceNumber": "Transaction_Reference_Number",
            "messageType": "Message",
            "messageDescription": "Description",
            "transferType": "Transfer_Type",
            "payrollTransactionAmount": 00.00,
            "transactionDate": "YYYY-MM-DD",
            "totalTransactionCount": 00,
            "grossAmount": 00.00,
            "valueDate": "YYYY-MM-DD",
            "fileSeqNo": "MMNN",
            "orderingCustomerAccountNumber": "Account_Number",
            "orderingCustomerName": "Name",
            "statusCode": "Code",
            "statusDesc": "Description"
          },
          {
            "companyCode": "Company_Code",
            "sequenceNum": "Sequence_Number",
            "transactionReferenceNumber": "Transaction_Reference_Number",
            "messageType": "Message",
            "messageDescription": "Description",
            "transferType": "Transfer_Type",
            "payrollTransactionAmount": 00.00,
            "transactionDate": "YYYY-MM-DD",
            "totalTransactionCount": 00,
            "grossAmount": 00.00,
            "valueDate": "YYYY-MM-DD",
            "fileSeqNo": "MMNN",
            "orderingCustomerAccountNumber": "Account_Number",
            "orderingCustomerName": "Name",
            "statusCode": "Code",
            "statusDesc": "Description"
          }
        ]
      }
    ]
  }
}

Valid/Successful response description:

JSON Tag	Description	Data type
osvPlatformPayrollPaymentEnquiryRS	Payroll Payment Enquiry Response Tag	Object
osvPlatformBanks	Array of Banks	Array
bankCode	Bank Code	String
messageType	Requested Payment Type - Bulk or Single	String
osvPlatformTransactions	Array of transactions for enquiry	Array
companyCode	Company Code	String
sequenceNum	Sequence Number	String
transactionReferenceNumber	Transaction Reference Number	String
messageType	Message type	String
messageDescription	Descriptive message	String
transactionType	Transaction Type	String
payrollTransactionAmount	Amount of the transaction	String
transactionDate	Scheduled/Processed date	String
totalTransactionCount	Number of transactions in the payroll	String
grossAmount	Gross amount of the payroll	String
valueDate	Date	String
fileSeqNo	File Sequence Number	String
orderingCustomerAccountNumber	Account number of the ordering customer	String
orderingCustomerName	Name of the ordering customer	String
statusCode	Status Code	String
statusDesc	Status Description	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