Introduction

Welcome to the PayPen Developer Documentation where you'll find how to integrate your system with the PayPen API.

Before you begin

Please ensure you have already registered as an Employer. Click here to signup. Then proceed to login. After you have successfully logged in, you will find a button on the right with the text, My Companies. Click on it and copy your API Key. Proceed to consume the login endpoint which you will need for your subsequent requests.

Also note that all API requests must specify application/json as the Content-Type.

Authentication

PayPen uses OAuth 2.0 as the basic security protocol. Authenticate your API calls by including your api bearer token in the Authorization header of every request you make.

API requests made without authentication will fail with the status code 401: Unauthorized. All API requests must be made over HTTPS.

Authorization headers should be in the format: Authorization: Bearer TOKEN

You can generate your api bearer by calling the Authentication endpoint as described below:

POST - https://paypen.ng/api/employer/auth/login

Headers

                
{
    "Content-Type": "application/json"
}
                
            

Sample Payload

                
{
    "api_key": "xxxx",
    "email": "someone@example.com"
}
                
            

Sample Response

                    
{
    "success": true,
    "message": "Login successful",
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.xxxxx"
    }
}