Skip to main content
GET
https://api-staging.fossapay.com
/
api
/
v1
/
customers
/
{customerId}
Get Customer by ID
curl --request GET \
  --url https://api-staging.fossapay.com/api/v1/customers/{customerId} \
  --header 'x-api-key: <x-api-key>'
{
  "status": "success",
  "statusCode": 200,
  "message": "Customer retrieved successfully",
  "data": {
    "id": "fh8e2e1f-e253-23ac-b8ft-31ed2t7fb0df",
    "businessId": "xse5f9867-f6b3-4dda-9d1e-aa335fbf7a3a",
    "firstName": "John",
    "lastName": "Ben",
    "middleName": "Doe",
    "emailAddress": "[email protected]",
    "mobileNumber": "0918458251",
    "dob": "1991-08-15",
    "customerType": "individual",
    "address": "12 customer rd.",
    "city": "Lagos",
    "tierId": 0,
    "createdAt": "2021-01-08T21:39:52+01:00"
  }
}

​
Overview

Retrieve detailed information about a specific customer using their unique customer ID.

​
Request

​
x-api-key
string
required
Your API key for authentication
​
customerId
string
required
The unique identifier of the customer

​
Response

​
status
string
Response status: success or error
​
statusCode
number
HTTP status code (200 for successful retrieval)
​
message
string
Human-readable response message
​
data
object
Customer object

​
Response Example

{
  "status": "success",
  "statusCode": 200,
  "message": "Customer retrieved successfully",
  "data": {
    "id": "fh8e2e1f-e253-23ac-b8ft-31ed2t7fb0df",
    "businessId": "xse5f9867-f6b3-4dda-9d1e-aa335fbf7a3a",
    "firstName": "John",
    "lastName": "Ben",
    "middleName": "Doe",
    "emailAddress": "[email protected]",
    "mobileNumber": "0918458251",
    "dob": "1991-08-15",
    "customerType": "individual",
    "address": "12 customer rd.",
    "city": "Lagos",
    "tierId": 0,
    "createdAt": "2021-01-08T21:39:52+01:00"
  }
}

​
Example

    ​
    Rate Limits

    • Maximum 100 requests per minute per API key
    • Burst limit of 20 requests per second