v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

API Key

API Key - Create

Create a new API Key for accessing our APIs from your servers. The plaintext API Key will be displayed only once on creation, so ensure you store it securely.

post/api_keys/{merchant_id}

Path parameters

merchant_idstring required

The unique identifier for the merchant account

Request body

namestring required

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 created

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.

api_keystring 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.

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"
}