Create and reveal an API key for a merchant user.

POST /api/api-keys/for-user deprecated

Requires: ApiKeyAuthorization.ApiKeys.CreateForUser, merchant scope.

Requires API key scope: admin (Administration)

Mints an API key owned by the target merchant user and returns it with the revealed value. A reseller or admin authorized over the user's merchant may call this. Every authorization or existence failure returns an identical not-found response.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a CreateApiKeyForMerchantUserDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/api-keys/for-user" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "00000000-0000-0000-0000-000000000002",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "name": "Warehouse terminal",
  "expireAt": "2030-12-31"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "userId": "00000000-0000-0000-0000-000000000002",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "name": "Warehouse terminal",
  "expireAt": "2030-12-31"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/api-keys/for-user' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, APIKeysApi } from '@winkpg/winkpg-api';

const api = new APIKeysApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantUserApiKeysCreateForMerchantUser({
  "userId": "00000000-0000-0000-0000-000000000002",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "name": "Warehouse terminal",
  "expireAt": "2030-12-31"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/api-keys/for-user', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userId": "00000000-0000-0000-0000-000000000002",
    "merchantId": "00000000-0000-0000-0000-000000000001",
    "name": "Warehouse terminal",
    "expireAt": "2030-12-31"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new APIKeysApi(config);
var body = JsonSerializer.Deserialize<CreateApiKeyForMerchantUserDto>("""
    {
      "userId": "00000000-0000-0000-0000-000000000002",
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "name": "Warehouse terminal",
      "expireAt": "2030-12-31"
    }
    """);

var result = await api.MerchantUserApiKeysCreateForMerchantUserAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/api-keys/for-user");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "userId": "00000000-0000-0000-0000-000000000002",
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "name": "Warehouse terminal",
      "expireAt": "2030-12-31"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.APIKeysApi(client)
    body = winkpg_api.CreateApiKeyForMerchantUserDto.from_dict({
      "userId": "00000000-0000-0000-0000-000000000002",
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "name": "Warehouse terminal",
      "expireAt": "2030-12-31"
    })
    result = api.merchant_user_api_keys_create_for_merchant_user(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "userId": "00000000-0000-0000-0000-000000000002",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "name": "Warehouse terminal",
  "expireAt": "2030-12-31"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/api-keys/for-user",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

userId required

string (uuid)

The identity user the key is minted for (the owner). Must be an active merchant user of `merchantId` in the current tenant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant the target user belongs to, used for the server-side scope check.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Human-readable key name. nullablemax length 32

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

expireAt required

string (date-time)

Required expiry. A durable credential provisioned for another user must not be immortal, so a null value is rejected. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

Body: ApiKeyRevealedDto ApiKeyRevealedDto Each item has these fields.

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Gets or sets the display name of the API key. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

keyPrefix required

string

Gets or sets the leading characters of the key value, safe to display. `null` for a key the rewrap backfill has not reached. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

last4 required

string

Gets or sets the trailing characters of the key value, safe to display. `null` for a key the rewrap backfill has not reached. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

environment required

ApiKeyEnvironment ApiKeyEnvironment

Gets or sets which world the key acts in, or `null` when it has never been stamped. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Test`	The key acts against the processor's test host. No live money moves. Minted with the sk_test_ prefix.
`Live`	The key acts against the processor's live host. Minted with the sk_live_ prefix.

status required

ApiKeyStatus ApiKeyStatus

Gets or sets the key's administrative state.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Active`	The key is in service. Whether it is currently accepted also depends on its expiry.
`Revoked`	The key has been revoked and is rejected at authentication for good. Revoked keys are retained rather than deleted so the audit trail of what the key did survives it.
`Suspended`	The key has been put out of service temporarily, pending someone deciding whether the use that triggered it was legitimate. Rejected at authentication exactly as a revoked key is, and reinstatable, which is the whole reason it is not one.

maskedKey required

string

Gets the key's display form: its retained prefix, an ellipsis, and its last characters. This is the only representation of the value any read path carries. nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastUsedAt required

string (date-time)

Gets or sets the UTC instant the key was last used to authenticate, or `null` when it has no recorded use. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

Gets or sets the UTC instant the key was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

Gets or sets the merchant the key was minted for, or `null` when it is not tied to one. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

active required

boolean

Gets or sets a value indicating whether the API key is active.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

expireAt required

string (date-time)

Gets or sets the expiration date for the API key. Null indicates the key does not expire. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

userId required

string (uuid)

Gets or sets the user ID that owns this API key.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

replacesKeyId required

string (uuid)

Gets or sets the key this one was minted to replace, or `null` when it was not created by a rotation. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

replacedByKeyId required

string (uuid)

Gets or sets the key minted to replace this one, or `null` when it has not been rotated. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

overlapExpiresAt required

string (date-time)

Gets or sets when this key's rotation overlap closes and it stops authenticating, or `null` when it is not in one. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowedCidrs required

array of string array of

Gets or sets the source addresses this key may be used from, as CIDR ranges or bare addresses, or `null` when it is not bound to any and may be used from anywhere. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

scopes required

array of string array of

Gets or sets the capability scopes this key is restricted to, or `null` when it is unrestricted and may reach everything its owner can. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

key required

string

Gets or sets the plaintext API key value. Shown once, at creation, and never again. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

replacedKeyOverlapExpiresAt required

string (date-time)

Gets or sets when the key this one replaced stops authenticating, or `null` when this key was not created by a rotation, or was created by one that cut over immediately. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

The API reference isn't available right now

No such operation

This reference may be out of date

Create and reveal an API key for a merchant user.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication