Payroll payments enquiry

Know Payroll payment status & details with Singleview Payments API

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 TagDescriptionData type
clientId
Mandatory
Client IDString
clientCode
Mandatory
Client CodeString
osvPlatformPayrollPaymentEnquiryRQ
Mandatory
Payroll Payment Enquiry Request TagObject
userName
Mandatory
Account UsernameString
osvPlatformBanks
Mandatory
Array of BanksArray
bankCode
Mandatory
Bank Code as per Bank NameString
messageType
Mandatory
Type of paymentString
osvPlatformTransactions
Mandatory
Array of TransactionsArray
companyCode
Mandatory
Company CodeString
transactionReferenceNumber
Mandatory
Transaction Reference Number of the paymentString
messageDescription
Mandatory
Description messageString
debitAccountNumber
Mandatory
Debit account numberString
date
Mandatory
Scheduled or due date of the paymentString
fileSeqNo
Mandatory
File sequence numberString

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 TagDescriptionData type
osvPlatformPayrollPaymentEnquiryRSPayroll Payment Enquiry Response TagObject
osvPlatformBanksArray of BanksArray
bankCodeBank CodeString
messageTypeRequested Payment Type - Bulk or SingleString
osvPlatformTransactionsArray of transactions for enquiryArray
companyCodeCompany CodeString
sequenceNumSequence NumberString
transactionReferenceNumberTransaction Reference NumberString
messageTypeMessage typeString
messageDescriptionDescriptive messageString
transactionTypeTransaction TypeString
payrollTransactionAmountAmount of the transactionString
transactionDateScheduled/Processed dateString
totalTransactionCountNumber of transactions in the payrollString
grossAmountGross amount of the payrollString
valueDateDateString
fileSeqNoFile Sequence NumberString
orderingCustomerAccountNumberAccount number of the ordering customerString
orderingCustomerNameName of the ordering customerString
statusCodeStatus CodeString
statusDescStatus DescriptionString

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