PAYMAXXI PAGA API DOCUMENTATION

THIS PAGE EXPLAINS HOW TO CREATE A NEW PAGA ACCOUNT USING THE CREATEPAGA API ENDPOINT.

ENDPOINT

POST HTTPS://APP.PAYMAXXI.COM.NG/API/CREATEPAGA

HEADERS

CONTENT-TYPE: APPLICATION/JSON
AUTHORIZATION: TOKEN YOUR_TEST_USER_TOKEN
  

REQUEST PAYLOAD

SEND THE FOLLOWING JSON PAYLOAD IN THE REQUEST BODY. ONLY FNAME, LNAME, AND PHONE ARE REQUIRED:

{
    "fname": "John",
    "lname": "Doe",
    "phone": "08012345678"
}
  

PHP CURL EXAMPLE

<?php
$url = "https://app.paymaxxi.com.ng/api/createpaga";
$authToken = "YOUR_TEST_USER_TOKEN";

$payload = [
    "fname" => "John",
    "lname" => "Doe",
    "phone" => "08012345678"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Token {$authToken}"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));

$response = curl_exec($ch);
$error    = curl_error($ch);
curl_close($ch);

if ($error) {
    echo "CURL ERROR: " . $error;
} else {
    echo "RESPONSE: " . $response;
}
?>
  

RESPONSE

THE API WILL RETURN A JSON RESPONSE WITH EITHER SUCCESS OR ERROR DETAILS:

{
    "status": "success",
    "data": {
        "account_number": "1234567890",
        "account_name": "John Doe",
        "unique_id": "0G6ST5JA4Z"
    }
}
  

OR AN ERROR RESPONSE:

{
    "status": "error",
    "message": "MISSING REQUIRED FIELD: LNAME"
}