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.

Usage 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.
Sending User ID 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.

Path Params
string
required

The merchant ID that the request should operate on.

Body Params
string

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.

string
required

Description associated with the new key.

permissions
array of strings
required
permissions*
Headers
string
required

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

Response

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json