v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

API Key

API Key - Update

Update information for the specified API Key.

post/api_keys/{merchant_id}/{key_id}

Path parameters

merchant_idstring required

The unique identifier for the merchant account

key_idstring required

The unique identifier for the API Key

Request body

namestring nullable

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

descriptionstring nullable

A description to provide more context about the API Key.

Example request

{
  "name": "Sandbox integration key",
  "description": "Key used by our developers to integrate with the sandbox environment"
}

Response

API Key updated

key_idstring required

The identifier for the API Key.

merchant_idstring required

The identifier for the Merchant Account.

namestring required

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

descriptionstring nullable

The description to provide more context about the API Key.

prefixstring required

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

createdstring date-time required

The time at which the API Key was created.

Example response

{
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Sandbox integration key",
  "description": "Key used by our developers to integrate with the sandbox environment",
  "created": "2022-09-10T10:11:12Z"
}