Payments API ReferenceAuth

Create POS credentials

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

POS credentials information to create
aliasstringRequired
Alias for the POS credentials
passwordstringRequiredformat: "password">=12 characters
Password for the POS credentials

Response

POS credentials created successfully
emailstring or null

Errors