POST
/
api_keys
/
{merchant_id}
/
{key_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

key_id
string
required

The unique identifier for the API Key

Body

application/json

The request body for updating an API Key.

name
string | null

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

Maximum length: 64
description
string | null

A description to provide more context about the API Key.

Maximum length: 256
expiration
Available options:
never

Response

200 - application/json

The response body for retrieving 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
prefix
string
required

The first few characters of the plaintext API Key to help you identify it.

Maximum length: 64
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
API Key - RetrieveAPI Key - Revoke