Customer Enrollment & KYC

List Customers

Retrieve a paginated list of all enrolled customers for the authenticated merchant.

GET /v1/customer

Request

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	❌	`1`	Page number
`limit`	integer	❌	`10`	Records per page

Code Samples

const axios = require("axios");

const response = await axios.get(
  "https://sandbox.hitchpay.ng/v1/customer",
  {
    params: { page: 1, limit: 10 },
    headers: {
      Authorization: `Bearer ${process.env.ACCESS_TOKEN}`
    }
  }
);

console.log(response.data);

<?php

$params = http_build_query(["page" => 1, "limit" => 10]);

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/customer?{$params}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ]
]);

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

echo $response;

import requests

url = "https://sandbox.hitchpay.ng/v1/customer"

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

params = {"page": 1, "limit": 10}

response = requests.get(url, headers=headers, params=params)
print(response.json())

Response

200 — Success

{
  "status": "success",
  "message": "Customers retrieved successfully.",
  "data": {
    "total_count": 3,
    "page": 1,
    "limit": 10,
    "customers": [
      {
        "uuid": "42feffe9-d625-412e-bfa5-2f3089a11735",
        "customerid": "CUST_001",
        "firstname": "Olajide",
        "lastname": "Olamide",
        "email": "[email protected]",
        "phone": "07068363556",
        "kyc_status": "approved"
      }
    ]
  }
}

Questions? Email [email protected]. Also on GitBook.