Getting Started

Introduction#

Welcome to the Payoxem API documentation. This guide provides detailed information on how to integrate with Payoxem's services using our API.

Our base url is https://payoxem.ng/api/

Authentication#

Payoxem API uses token-based authentication. To access protected resources, you need to include an access token in your request headers.

Obtaining an Access Token

Before making API requests, you must obtain an access token by sending a POST request to the following endpoint:
Endpoint: https://payoxem.ng/api/auth/login
Request Method: POST
Request Parameters:
  • email (string, required): Your email address.
 • password (string, required): Your account password.
 • expire (integer, optional): Expiration days for which the token will be valid. Default is 7 days

Example Request

curl -X POST \
  https://payoxem.ng/api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
     "email": "user@example.com",
     "password": "password123",
     "expire": 360
     }'

Example Response

{

  "status": true,

  "data": {

  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",

  "expiration_date": "Dec. 25, 2023 at 20:55"

},

  "message": "Token generated successfully",

"status_code": 200

}

Get Account Information#

Retrieve details about your account.

Endpoint: https://payoxem.ng/api/user/info
Request Method: GET
Request Parameters: NONE
Header:
 • Authorization: Bearer < Token Generated >

Example Request

curl -X GET \

  https://payoxem.ng/api/user/info \

  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Example Response

{

    "status": "success",

    "data": {

        "basic": {

            "firstname": "OGDesigns",

            "lastname": "Inc.",

            "email": "noreply@payoxem.ng",

            "package": "reseller"

        },

        "wallets": {

            "naira_balance": "735.75",

            "referral_balance": ""

        },

        "dedicated_accounts": {

            "kuda_bank": "0123456789",

            "fidelity_bank": null

        }

    },

    "status_code": 200

}