Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Merchants

Create Merchant API Keys

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This request will create a new API key for a user on a merchant account. The request includes all key types, including those for the Payment API, Query API, Collect.js, and Collect Checkout. </details> <details> <summary> Sending User ID</summary> The `userId` is optional, and will default to the primary user on the account if it is not provided.

A full list of user IDs on merchant accounts can be queried via Get Merchant or Partner User Info.

</details>
post/v4/merchants/{gateway_id}/security_keys

Path parameters

gateway_idstring required

The merchant ID that the request should operate on.

Headers

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

userIdstring

The merchant user for whom to generate the API key. Optional and will default to primary user on the account if it is not provided.

descriptionstring required

Description associated with the new key.

permissionsstring[] required

Response

Success

objectType'securityKey'

The type of object that was created as a result of the request.

idstring

The ID of the merchant key that was created.

keyTextstring

The value of the key to be sent in with API requests or passed into Collect.js. This can be accessed later in the Security Keys section of the Merchant's Settings.

userIdstring

The merchant user ID associated with the key that was created.

descriptionstring

The description assigned to the key. Matches that passed in the request.

permissionsstring[]

The permissions assigned to the key. Matches those passed in the request except that tokenization will be added to collectCheckout keys automatically.