Process payroll payments

/api/v1/payroll/transfer

POST

1. CompanyId
2. SVReferenceID
3. DateTimeStamp
4. Device
5. Authorization: Bearer

OSVPayrollPaymentMessageRequest

Mandatory

Root node containing all the payroll payment transaction messages

Object

TransactionType

Mandatory

Type of transaction to be mentioned as PAYROLL

String

OSVPayrollTransactionRequest

Mandatory

This tag contains multiple banks requests

Object

BankCode

Mandatory

Unique bank identification code (SingleView Identifier) Ex:ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ

Alphabetical

PayrollReferenceNumber

Mandatory

It is a unique reference number generated by the customer for each payroll processing Max size of input: 16 Characters

Numeric

CorporateCommercialRegistrationNumber

Conditional
Mandatory for NCB

Unique corporate commercial registration identification details Max size of input: 15 Characters

String

MolCorporateID

Conditional
Mandatory for NCB, SAB, and ANB

Unique MoI assigned corporate identification details Max size of input: 15 Characters

String

FileSeqNo

Conditional
Mandatory for NCB

Unique file sequence number of the WPS payroll request 4 Digit Number in the format of MMSS MM - Current month SS - Sequence of payroll for the month

Numeric

CompanyCode

Mandatory

Unique company identification code

String

OrderingCustomerNameAddress

Mandatory

Tag carrying information on the ordering customer name and address

Object

OrderingCustomerName

Mandatory

Name of the ordering customer as per bank records

String

OrderingCustomerAdd1

Mandatory

Ordering Customer’s Address Line 1 Input size: Min - 3 Characters Max - 35 Characters

String

OrderingCustomerAdd2

Mandatory

Ordering Customer’s Address Line 2 (city to be mentioned) Input size: Min - 3 Characters Max - 35 Characters

String

OrderingCustomerAdd3

Mandatory

Ordering Customer’s Address Line 3 Input size: Min - 3 Characters Max - 35 Characters

String

OrderingInstitution

Mandatory

Ordering Institution Ex: SABBSARI, RJHISARI Maximum length: 8 or 11 characters

Alphanumeric

OrderingCustomerAccountNumber

Conditional

Account number of the ordering customer Mandatory if OrderingCustomerIBAN is not provided

Alphanumeric

OrderingCustomerIBAN

Conditional

International Bank Account Number of the ordering customer

Alphanumeric

TransactionData

Mandatory

Tag carrying information on payroll transactions

Object

SequenceNum

Mandatory

Unique sequence number for each transaction in the payroll generated by the client

Numeric

DateCurrencyAmount

Mandatory

Tag carrying information on transaction currency, date and amount

Object

Currency

Mandatory

Unique code representing the currency of the transaction Max size of input: 3 Characters

Alphabetical

Amount

Mandatory

Amount of the transaction

Numeric

Date

Mandatory

Date of the transaction in YYMMDD format

Date

BeneficiaryBankCode

Mandatory

Unique bank identification code for beneficiary account (SingleView Identifier) Ex:ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ

Alphanumeric

BeneficiaryAccountWithInstitutionBIC

Mandatory

Beneficiary BIC Code Ex: SABBSARI, RJHISARI Maximum length: 8 or 11 characters

Alphanumeric

BeneficiaryAccountNumberNameAddress

Mandatory

Element root containing details of Beneficiary

Object

BeneficiaryAccount

Mandatory

Beneficiary bank account number Input size: Min - 11 Characters Max - 24 Characters

Alphanumeric

BeneficiaryName

Mandatory

Name of the beneficiary

String

BeneficiaryAdd1

Mandatory

Beneficiary Address Line 1 Input size: Min - 3 Characters Max - 35 Characters

String

BeneficiaryAdd2

Mandatory

Beneficiary Line 2 (city to be mentioned) Input size: Min - 3 Characters Max - 35 Characters

String

BeneficiaryAdd3

Mandatory

Beneficiary Address Line 3 Input size: Min - 3 Characters Max - 35 Characters

String

PaymentDetails

Mandatory

Payroll transaction description Max size of input: 35 Characters

String

SalaryDetails

Mandatory

Tag carrying salary information

Object

Id

Mandatory

Iqama or National ID number of the beneficiary

Alphanumeric

EmployeeID

Conditional
Mandatory for GIB

Unique employee identification details

Alphanumeric

BasicSalary

Mandatory

Amount for basic salary

Numeric

HousingAllowance

Mandatory

Salary breakdown indicating the amount allocated to the beneficiary under housing allowances

Numeric

OtherEarnings

Mandatory

Additional amount to be credited apart from basic and housing allowance

Numeric

Deductions

Mandatory

Total amount that indicates the deductions for the concerned beneficiary

Numeric

TransactionComment

Mandatory

Comment regarding the payroll transaction

String

TotalTransactionCount

Mandatory

Total count of transactions included in the payroll

Numeric

TotalTransactionAmount

Mandatory

Total amount of transactions included under a specific debit account

Numeric

Signature

Mandatory

Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature)

String

OSVPayrollMessageResponse

Root node

Object

OSVPayrollTransactionResponse

Element root containing response of every bank transactions

Object/Array

BankCode

Unique bank identification code Ex:ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ

Alphanumeric

PayrollReferenceNumber

Payroll Reference Number

Numeric

TransactionData

This tag contains the status of the payments

Object/Array

CompanyCode

Sender company Code/Identifier

String

MessageType

Type of message

String

MessageDescription

Details about the response

String

TransactionDate

Date of the transaction

String

FileSeqNo

Unique file sequence number of the payroll

Numeric

TransferType

Type of transfer MT-100 Payroll

String

BankReferenceNumber

Unique bank reference number of the payroll transaction

Alphanumeric

StatusCode

Code representing status of the request represented as:

• OK
• Failed
• ONHOLD

String

StatusDetail

Details about the status of the request

String