Employer API Documentation :: schedule-creation

Schedule Creation

Allows you to submit/upload your Pension Remittance schedule for your employees.

POST - https://paypen.ng/api/employer/schedule/create

Headers

                
{
    "Content-Type": "application/json"
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.xxxxx"
}

Sample Payload

                
{
    "remittance_type": "COMPVOL",
    "data": [
        {
            "pfa": "030",
            "staff_id": "12345",
            "pin": "PEN100xxxxxxxx69",
            "employee_name": "John Doe",
            "employer_contribution": 1000,
            "employee_contribution": 1000,
            "employer_voluntary": 500,
            "employee_voluntary": 500,
            "total_contribution": 3000,
            "period": "May-2024"
        }
    ]
}

Sample Response

    
{
    "has_error": false,
    "message": "Operation succeeded.",
    "data": [
        {
            "ppid": "TX10xxxxxx02",
            "amount_payable": 300000,
            "payment_due_date": "2024-05-30 15:45:23",
            "account_name": "John Doe Limited",
            "account_number": 0123456789,
            "bank_name": "Wema Bank",
            "invoice_status": "PENDING",
            "created_by": "John Doe",
            "created_on": "2024-05-20 15:45:23"
        }
    ]
}

This response indicates that everything went well and your schedule has uploaded successfully uploaded. This process also triggers an email with your invoice, carrying same information as in the above response.

Field

Description

has_error

Indicates whether or not the request results in an error

message

The operation response message

data

Contains the invoice details to be used for making payment.

ppid	PayPen ID - used to track or report issue on your schedule.
amount_payable	EXACT Amount to be paid for the schedule.
payment_due_date	Indicates when the invoice expires if not paid.
account_name	The name you want to be attached to the reserved account.
account_number	Your dedicated virtual account number for the schedule.
bank_name	Name of the bank where the virtual account was created.
invoice_status	Indicates the status of your invoice. PENDING means you haven't made payment.
created_by	The API consumer, as previously authenticated.
created_on	Date schedule was created.

In the case where your schedule creation was successful but we are unable to generate an invoice, you will get the following response:

Sample Invoice Creation Failure Response

                
{
    "success": true,
    "message": "Schedule successfully saved but could not generate invoice at this time.
                You can always generate the invoice at any time using the PPID assigned to this schedule.",
    "data": [
        {
            "ppid": "TX10xxxxxx02",
            "status": "PENDING INVOICE GENERATION",
            "created_by": "John Doe",
            "created_on": "2024-05-20 15:45:23"
        }
    ]
}

This could be as a result of communication failure between PayPen and our Payment Gateway. A email is automatically triggered to PayPen to investigate the reason for this failure and proffer solution.

You can always make a call to the invoice creation endpoint in order to generate an invoice for your schedule.

In another scenario, you could run into a validation error, which may look like this:

Sample Validation Error Response

                
{
  "success": false,
  "message": "Validation errors",
  "errors": [
    {
      "Record 1": [
        "PEN100xxxxxxxx69 is not a valid RSA PIN. A valid RSA PIN is 15 characters"
      ]
    }
  ]
}

Previous: Introduction Next: Schedule Details