Overview

Singleview Payroll Payment Enquiry services connects the Corporate users via a secure channel and enables them to enquire the status of their posted transactions quickly and easily. The key feature of the service allows the user to get immediate acknowledgment about the most recent status of their payments.

🌐Domain details

Sandbox API - https://sandbox.onesingleview.com

Production/LIVE API - To be provided upon onboarding

Endpoint details

Endpoint	Method	Grant type	Service validations
`/api/v1/batch/payroll/paymentenquiry`	POST	The header should include: 1. `clientId` 2. `clientCode` 3. `Access Token` 4. `SVReferenceID` 5. `CompanyId`	Refer validations

Sample request

curl --location 'https://sandboxapi.onesingleview.com/api/batch/payroll/paymentenquiry' \
--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": {
	"OSVPayrollMessageRequest": {
		"TransactionType": "PAYROLL", 
		"OSVPayrollStatusRequest": [{
			"BankCode": "Enter_Bank_Code",
			"PayrollTransactions": [{
				"CompanyCode": "Enter_Company_Code",                          
				"PayrollReferenceNumber": "Enter_Payroll_Reference_Number",              
				"MessageDescription": "Payroll_Message-xxxxxxxxxx"   
			}]
		},
		{
			"BankCode": "Enter_Bank_Code",
			"PayrollTransactions": [{
				"CompanyCode": "Enter_Company_Code",                          
				"PayrollReferenceNumber": "Enter_Payroll_Reference_Number",              
				"MessageDescription": "Payroll_Message-xxxxxxxxxx"     
			}]
		}]
	}

},

	
	"Signature": "Enter_Signature"
}

Request Description

JSON Tag	Description	Data type
OSVPayrollMessageRequest Mandatory	Root node containing all the payroll payment transaction messages	Tag
TransactionType Mandatory	Always it should be "PAYROLL"	String
OSVPayrollStatusRequest Mandatory	This tag contains enquiry for multiple banks requests	Object
BankCode Mandatory	Bank Code (Identifier) Ex: “ALRAJHI”, “SABB”	String
PayrollTransactions Mandatory	This tag contains details of various payroll transactions for enquiry	Object
CompanyCode Mandatory	Sender company code/Identifier provided by the bank	String
PayrollReferenceNumber Mandatory	It is a unique reference number generated by the customer for each payroll processing) Maximum length : 16 numeric characters	String
MessageDescription Mandatory	Message details concerned to the specific payroll	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

✅ Successful response

{
	"OSVPayrollMessageResponse": {		
		"OSVPayrollTransactionResponse": [{
				"BankCode": "Bank_Code",	
				"PayrollReferenceNumber": "Payroll_Reference_Number",	
				"TransactionData": [{
					"CompanyCode": "Company_Code",									
					"MessageType": "Message",                                     
					"MessageDescription": "Payroll_Message_Acknowledgement",    
					"TransactionDate": "YYYYMMDD",                            
					"TransferType": "MT100-Payroll",                            				                                
					"StatusCode": "Status_Code",                                         
					"StatusDetail": "Status_Detail"               
				}]
			},
			{
				"BankCode": "Bank_Code",	
				"PayrollReferenceNumber": "Payroll_Reference_Number",	
				"TransactionData": [{
					"CompanyCode": "Company_Code",									
					"MessageType": "Message",                                     
					"MessageDescription": "Payroll_Message_Acknowledgement",    
					"TransactionDate": "YYYYMMDD",                            
					"TransferType": "MT100-Payroll",                            				                                
					"StatusCode": "Status_Code",                                         
					"StatusDetail": "Status_Detail"              
				}]
			}]
	}		
}

Response description

JSON Tag	Description	Data type
OSVPayrollMessageResponse	Root node	Object
OSVPayrollTransactionResponse	Element root containing response of every bank transactions	Object/Array
BankCode	Name of the bank. Ex: “ALRAJHI”, “SABB”	String
PayrollReferenceNumber	Payroll Reference Number	String
TransactionData	This tag contains the status of the payments	String
CompanyCode	Sender company Code/Identifier	String
MessageType	Type of message	String
MessageDescription	Details about the response	String
TransactionDate	Value of “SequenceNum” tag in the request message. Maximum Length :16 digits numeric	String
TransferType	Type of transfer (MT-100 Payroll)	String
StatusCode	Status code of the response SUCCESS- For successfully settled payment PENDING- For a pending payment FAILED- For a payment failed processing	String
StatusDetail	Details about the status of the request	String

❌ Invalid/Failed response

{
        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

⚠️ 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