Skip to main content
GET
/
v1
/
accountholders
/
{accountHolderId}
curl --request GET \
  --url https://api.staging.kairosafrika.cloud/paygw/v1/accountholders/233559400612 \
  --header 'Authorization: Basic $(echo -n "username:password" | base64)'

{
  "statusCode": "0000",
  "statusMessage": "Successful",
  "transactionId": "454545455",
  "sequenceNo": "030720241222005656869",
  "data": {
    "accountName": "Lord Acheampong",
    "msisdn": "233559400612",
    "network": "MTN"
  },
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ]
}

​
Get Account Holder

This endpoint allows you to retrieve details of an account holder by their unique identifier. Endpoint: GET /v1/accountholders/{accountHolderId} 
curl --request GET \
  --url https://api.staging.kairosafrika.cloud/paygw/v1/accountholders/233559400612 \
  --header 'Authorization: Basic $(echo -n "username:password" | base64)'

​
Path Parameter

  • accountHolderId (string, required): The unique identifier of the account holder to retrieve.
    • Example: 233559400612

​
Responses

​
200 OK - Success Response

Returns account holder details when found. 
{
    "statusCode": "0000",
    "statusMessage": "Successful",
    "transactionId": "454545455",
    "sequenceNo": "030720241222005656869",
    "data": {
        "accountName": "John Doe",
        "msisdn": "2335548908839",
        "network": "MTN"
    },
    "links": []
}

​
404 Not Found - Account Holder Not Found

{
    "statusCode": "0404",
    "statusMessage": "Account holder not found",
    "transactionId": null,
    "sequenceNo": null,
    "data": null,
    "links": []
}

​
401 Unauthorized - Invalid Credentials

{
    "statusCode": "0401",
    "statusMessage": "Unauthorized",
    "transactionId": null,
    "sequenceNo": null,
    "data": null,
    "links": []
}

​
Response Fields

  • statusCode (string): Status code indicating the result of the request
    • "0000": Successful
    • "0404": Account holder not found
    • "0401": Unauthorized
  • statusMessage (string): Human-readable status message
  • transactionId (string): Unique transaction identifier for tracking
  • sequenceNo (string): Sequence number for the request
  • data (object): Account holder information when successful
    • accountName (string): Account holder’s full name
    • msisdn (string): Mobile subscriber identifier
    • network (string): Mobile network provider (e.g., MTN, Vodafone)
  • links (array): HATEOAS links for related actions

​
Usage Example

The examples above show how to authenticate and retrieve account holder information using different programming languages.

Authorizations

​
Authorization
string
header
required

Basic authentication using base64 encoded username:password

Path Parameters

​
accountHolderId
string
required

The unique identifier of the account holder

Response

Account holder details retrieved successfully

​
statusCode
string

Status code indicating the result of the request

Example:

"0000"

​
statusMessage
string

Human-readable status message

Example:

"Successful"

​
transactionId
string

Unique transaction identifier for tracking

Example:

"454545455"

​
sequenceNo
string

Sequence number for the request

Example:

"030720241222005656869"

​
data
object | null

Account holder information when successful

​
links
object[]

HATEOAS links for related actions