GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language
string
default:en

Preferred language for the response

Body

application/json
merchantAccountNumber
integer
required

The merchant account

Example:

35253486

clientKey
string
required

The unique identifier of the client API key to retrieve

Example:

"abcdefghijklmnopqrstuvwxyz1234"

Response

200 - application/json

Success - Client API key details retrieved

Detailed information about a client API key

clientId
integer
required

The unique identifier of the client API key

Example:

23

organisationId
string
required

The unique identifier of the organisation

Example:

"FYH0NTVW0DXK"

merchantAccountNumber
integer
required

The unique identifier of the merchant account

Example:

35253486

clientKey
string
required

The client API key (typically 30 characters)

Example:

"abcdefghijklmnopqrstuvwxyz1234"

capturedBy
string
required

The username or identifier of the user who created the API key

Example:

"Jdoe"

statusCode
string
required

The status code of the API key (e.g., "A" for Active, "I" for Inactive)

Example:

"A"

statusName
string
required

The human-readable status name of the API key

Example:

"Active"

dateCaptured
string<date-time>
required

The date and time when the API key was created in UTC format

Example:

"2025-11-01T10:30:00.000Z"

clientSecret
string | null

The client API secret (typically 45 characters). Note: This field may be null or empty as secrets are not typically returned for security reasons

Example:

null

expiryDate
string<date-time> | null

The expiration date and time for the API key in UTC format (ISO 8601). Note: This field may be null if expiry is not set

Example:

null

modifiedBy
string | null

The username or identifier of the user who last modified the API key. May be null if never modified

Example:

null

dateModified
string<date-time> | null

The date and time when the API key was last modified in UTC format. May be null if never modified

Example:

null