Create POS credentials

Creates new POS 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
POS Credentials Creation:
- Alias and password are required
- Email is automatically generated: {alias}-{merchant-slug}.pos@koywe.com
- Merchant name is slugified (spaces and invalid chars replaced with hyphens)
Permission Requirements:
- User must have MERCHANT_DEV_SETTINGS_CREATE_API_KEY permission

Creates new POS credentials for a merchant with the following validations: 1. **Organization Validation**: - Organization must exist - User must have access to the organization 2. **Merchant Validation**: - Merchant must exist - Merchant must belong to the specified organization - User must have the required permissions for the merchant 3. **POS Credentials Creation**: - Alias and password are required - Email is automatically generated: {alias}-{merchant-slug}.pos@koywe.com - Merchant name is slugified (spaces and invalid chars replaced with hyphens) 4. **Permission Requirements**: - User must have MERCHANT_DEV_SETTINGS_CREATE_API_KEY permission

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID

Request

This endpoint expects an object.

aliasstringRequired

Alias for the POS credentials

passwordstringRequiredformat: "password">=12 characters

Password for the POS credentials

Response

POS credentials created successfully

emailstring or null

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/auth/organizations/organizationId/merchants/merchantId/pos/credentials/create"
4
5	payload = {
6	"alias": "mypos",
7	"password": "Str0ng!POS-Secret"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

Create POS credentials

Authentication

Path parameters

Headers

Request

Response

Errors

1	{
2	"email": "mypos-merchant-name@koywe.com"
3	}