Skip to main content
GET
https://api-staging.fossapay.com
/
api
/
v1
/
customers
/
{customerId}
/
tier-status
Get Customer Tier Status
curl --request GET \
  --url https://api-staging.fossapay.com/api/v1/customers/{customerId}/tier-status \
  --header 'x-api-key: <x-api-key>'
{
  "status": "success",
  "statusCode": 200,
  "message": "Customer tier status retrieved successfully",
  "data": {
    "tierId": 0,
    "hasNin": false,
    "hasBvn": false
  }
}

​
Overview

Retrieve detailed tier information and usage limits for a specific customer.

​
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

​
Response Example

{
  "status": "success",
  "statusCode": 200,
  "message": "Customer tier status retrieved successfully",
  "data": {
    "tierId": 0,
    "hasNin": false,
    "hasBvn": false
  }
}

​
Tier Information

​
Tier Levels

  • basic: Standard tier with basic transaction limits
  • premium: Enhanced features and higher transaction limits
  • enterprise: Custom solutions with maximum limits

​
Status Values

  • active: Customer account is active and can transact
  • suspended: Customer account is temporarily suspended
  • pending: Customer account is under review

​
Example

    ​
    Rate Limits

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