Create API credentials
Creates new API credentials for a merchant with the following validations:
-
Organization Validation:
- Organization must exist
- User must have access to the organization
-
Merchant Validation:
- Merchant must exist
- Merchant must belong to the specified organization
- User must have the required permissions for the merchant
-
Role Assignment (required):
- At least one role must be provided
- Roles will be assigned to the API credentials for the merchant
- Roles must be valid merchant roles (not organization roles)
- Invalid or missing roles will result in a 400 error
-
Permission Requirements:
- User must have MERCHANT_DEV_SETTINGS_CREATE_API_KEY permission
Path parameters
organizationId
Organization ID
merchantId
Merchant ID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
API credentials information to create
name
Descriptive name to identify the purpose of the API credentials
roles
Array of role IDs or names to assign to the API credentials for the merchant. Must contain at least 1 role.
Response
API credentials created successfully
apiKey
Generated API Key for the merchant
secret
Generated Secret for the merchant