POST
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

Request payload for creating a new client API key

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"

clientSecret
string
required

The client API secret (typically 45 characters)

Example:

"ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789012345"

createdBy
string<email>
required

Email address of the user creating the API key

Example:

"admin@example.com"

Response

201 - application/json

API key has been created successfully

The response is of type string.

Example:

"API key has been created successfully"