Process External Payroll

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

/process/external-payroll

This endpoint allows registered companies submit payroll information for employees not registered on Eazipay for processing. It supports the processing of payroll entries for multiple staff members in a single request.

Input Schema

{
    month: Number,
    year: Number,
    staffPayrollDetails: [
        {
            staffId: String,
            staffName: String,
            grade: String,
            baseSalary: Number,
            totalAllowances: Number,
            tax: Number,
            pensionContribution: Number,
            otherDeductions: Number,
            salaryAccountNumber: String,
            salaryDomiciledBank: String,
            bankSortCode: String,
            netPayResponse: Number
        }
    ]
}

Response Schema

{
    success: Boolean,
    message: String,
    data: {
        month: Number,
        year: Number,
        companyName: String,
        initiatedBy: String,
        noOfEmployees: Number,
        deductedFromWallet: Number,
        totalGross: Number,
        totalNet: Number,
        totalStatutory: Number,
        totalDeduction: Number,
        totalBonus: Number,
        initiatedAt: String,
        transactionDate: String
    }
}

Body Params
int32
required

The month for which the payroll is being processed (1 to 12).

int32
required

The year for which the payroll is being processed

string
required

Unique identifier for the staff member

string
required

Name of the staff member

string
required

Grade or level of the staff member.

float
required

Base salary of the staff member

float
required

Total allowances for the staff member

float
required

Tax deduction for the staff member.

float
required

Pension contribution for the staff member

float
required

Any other deductions for the staff member

string
required

Bank account number of the staff member.

string
required

Bank where the salary is domiciled

string
required

Sort code of the bank

float
required

Net pay response for the staff member.

Headers
string

Bearer {your_api_key}

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json