Cancel a payroll

Cancel Payroll API enables businesses to submit cancellation requests for previously submitted payroll. It supports bank-specific cancellation requirements and returns the cancellation processing status along with relevant references and response details, where available.

Important information

Payroll cancellation requests must be submitted at least 24 hours before the scheduled value date, subject to the applicable bank's cancellation rules. A successful API response should be interpreted according to its returned status and the bank's processing requirements.

Domain details
Environment
Domain
Rate/Limit
Sandbox
sandboxapi.onesingleview.com
3 Calls per Minute
Production/LIVE
To be provided upon onboarding
Based on contract

Environment	Domain	Rate/Limit
Sandbox	sandboxapi.onesingleview.com	3 Calls per Minute
Production/LIVE	To be provided upon onboarding	Based on contract

Endpoint details

Endpoint URL	Method	Authentication requirements
`/api/v2/cancel/payroll`	POST	`SVReferenceID` `CompanyId` `Device` `DateTimeStamp` `Authorization: Bearer`

Sample request

Cancel Payroll Processing Request

curl --location 'https://sandboxapi.onesingleview.com/api/v2/cancel/payroll' \
--header 'SVReferenceID: 29214008782670' \
--header 'CompanyId: SVUATAPIDASHBOARD' \
--header 'Device: web' \
--header 'DateTimeStamp: 2026-06-23T10:20:39' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNaVN4MzdCZHREWlNGdTFad3B5QnlkOVpHelZXR2ZwUmFQNUYrZzB5YVg5bi9KVE5wK1FucERJMEZXWWN6VGJsOEc5cXhaY0U2TXlZbmNtWWZFMzZkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTV5c3h3dDRFektqdjdyS2tqQkpJcGo0VmJNeFlLbG5aNHc0V1ArT2FIVzNCNzkrUT0iLCJpYXQiOjE3ODIyMTM3MzUsImV4cCI6MTc4MjIxNzMzNX0.7YieIyFLapyIJ8fBw8gROzH8OqOlN650yrgFQ9xDqaU' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
"OSVCancelPayrollPaymentRequest": {
	"TransactionType": "CANCEL",
	"BankCode": "ANB",
	"CompanyCode": "OSV0001",
	"PayrollReferenceNumber": "128830",
	"BankReferenceNumber": "",
	"FileSeqNo": "0701",
	"OrderingCustomerAccountNumber": "11100201784801",
	"CancelReason": "Total file Stopped for payroll payment"
	}
},
"Signature": "szYN7DooWZFfnblL7isLasWXmOM/H3iWmHW04nAhAVTeXFyubbN/ztRT8d9h/uMU69YCNEmBiHYgiJswgyERUuY+JeaV0rdaEojjq0NAKojB3A0pqAINiVEa4hJLSpJYiSZwjDLYAbYWdOsaUSgzE6MgDuQHPRZc7qxD3ngUh9DtwKSkivpItAhhkQttqIyxntHVghGPzmtN/WAECcY9NN9ZrK8l31gLmxDb/BCjqh0wSXRgk9MNAWBmucamBeCzNCtQLIc3j0RUQTf4rBPeMgi7qf/2L66d+0Hpr4TzlHkmyn4deo+GxjgYEKqc0xP28PXsyvV6UKuWKmpEM+fTiA=="
}'

Request parameters

JSON Tag	Requirement	Description	Data type
OSVCancelPayrollRequest	Mandatory	Tag carrying information about the payroll to be cancelled	Object
TransactionType	Mandatory	Details of the transaction type to be mentioned as `CANCEL`	String
BankCode	Mandatory	Unique bank identification code processing the payroll `ALRAJHI` - Al Rajhi Bank `ANB` - Arab National Bank `NCB` - Saudi National Bank	String
CompanyCode	Mandatory	Company identifier registered with the service or bank	String
PayrollReferenceNumber	Mandatory	Reference details identifying the original payroll request	String
OrderingCustomerAccountNumber	Conditional Mandatory for NCB	Account number associated with the payroll ordering customer	String
FileSeqNo	Conditional Mandatory for NCB	Unique file sequence number of the payroll as provided by the bank	String
BankReferenceNumber	Conditional Mandatory for ANB	Bank-generated reference associated with the payroll transaction	String
CancelReason	Conditional Mandatory for Al Rajhi & SNB	Reason for requesting payroll cancellation	String
Signature	Mandatory	Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature)	String

Sample response

{
  "OSVPayrollCancelResponse": {
    "BankCode": "ANB",
    "CompanyCode": "125001291",
    "StatusCode": "Completed",
    "ErrorCode": "",
    "StatusDetail": "Payroll payments processing cancelled successfully.",
    "TimeStamp": "2026-07-09T10:20:39",
	"PayrollReferenceNumber": "98198322",
	"BankReferenceNumber": ""
    }
}

Response parameters

JSON Tag	Description	Data type
OSVPayrollCancelResponse	Tag carrying information on stop payroll process response	Object
BankCode	Code identifying the bank associated with the cancellation request	String
CompanyCode	Company identifier associated with the payroll	String
StatusCode	Status returned for the cancellation request	String
ErrorCode	Error code returned when the request fails or an error is identified	String
StatusDetail	Descriptive message explaining the cancellation outcome or current status	String
TimeStamp	Date and time associated with the response	String
PayrollReferenceNumber	Reference identifying the original payroll request	String
BankReferenceNumber	Bank-generated reference associated with the payroll cancellation	String
CancelReference	Cancellation reference returned by the bank provided only by Al Rajhi Bank This value is used to enquire about the cancellation status of the payroll.	String

Status Codes & Information

StatusCode	StatusDetail
Processing	Cancel payroll request submitted to bank successfully. Perform cancel payroll enquiry after some time to get updated status or contact SingleView support.
Completed	Payroll payments processing cancelled successfully.
Failed	Response description
Response_Timeout	Timeout! Unable to get response from the bank. Please try later or contact SingleView support.

Categories

GENERAL INFORMATION

GETTING STARTED

AUTHENTICATION

Data APIs

Payment APIs

SADAD

Virtual Accounts

SME Onboarding (Draft)

RESOURCES

API Archives

Cancel a payroll

Cancel a payroll

Endpoint details

Sample request

Sample response

Status Codes & Information