POST
/
api_keys
/
{merchant_id}

Authorizations

api-key
string
headerrequired

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Path Parameters

merchant_id
string
required

The unique identifier for the merchant account

Body

application/json

The request body for creating an API Key.

name
string
required

A unique name for the API Key to help you identify it.

Maximum length: 64
expiration
required
Available options:
never
description
string | null

A description to provide more context about the API Key.

Maximum length: 256

Response

200 - application/json

The response body for creating an API Key.

key_id
string
required

The identifier for the API Key.

Maximum length: 64
merchant_id
string
required

The identifier for the Merchant Account.

Maximum length: 64
name
string
required

The unique name for the API Key to help you identify it.

Maximum length: 64
api_key
string
required

The plaintext API Key used for server-side API access. Ensure you store the API Key securely as you will not be able to see it again.

Maximum length: 128
created
string
required

The time at which the API Key was created.

expiration
required
Available options:
never
description
string | null

The description to provide more context about the API Key.

Maximum length: 256
Profile - ListAPI Key - Retrieve