Create API key

POST /api/api-keys deprecated

Requires: ApiKeyAuthorization.ApiKeys, merchant scope.

Requires API key scope: admin (Administration)

Creates a new API key for programmatic access to the system.

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

Each example below is one request, shown in every language. Choose an example and a language, then replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

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

cURL PowerShell TypeScript C# Python

Merchant integration key

Creates a key owned by the calling merchant user for a server that takes payments. The key belongs to the merchant the caller is working in, is accepted only from the 203.0.113.0/24 range, reaches only the transaction, refund, customer and token operations, and stops authenticating at the expiry. Scopes only narrow what the owner may already do; they grant nothing. The server generates the key value, so the request never carries one: the reveal operation returns it once, and the plain create returns the key without it.

cURL

curl -X POST "{{BASE_URL}}/api/api-keys" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Checkout server",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "203.0.113.0/24"
  ],
  "scopes": [
    "transactions:write",
    "transactions:refund",
    "customers",
    "tokens"
  ]
}'

PowerShell

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

$body = @'
{
  "name": "Checkout server",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "203.0.113.0/24"
  ],
  "scopes": [
    "transactions:write",
    "transactions:refund",
    "customers",
    "tokens"
  ]
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/api-keys' `
    -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.apiKeysCreate({
  "name": "Checkout server",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "203.0.113.0/24"
  ],
  "scopes": [
    "transactions:write",
    "transactions:refund",
    "customers",
    "tokens"
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/api-keys', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Checkout server",
    "expireAt": "2030-12-31",
    "allowedCidrs": [
      "203.0.113.0/24"
    ],
    "scopes": [
      "transactions:write",
      "transactions:refund",
      "customers",
      "tokens"
    ]
  }),
});

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<ApiKeyCreateDto>("""
    {
      "name": "Checkout server",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "203.0.113.0/24"
      ],
      "scopes": [
        "transactions:write",
        "transactions:refund",
        "customers",
        "tokens"
      ]
    }
    """);

var result = await api.ApiKeysCreateAsync(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");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "Checkout server",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "203.0.113.0/24"
      ],
      "scopes": [
        "transactions:write",
        "transactions:refund",
        "customers",
        "tokens"
      ]
    }
    """, 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.ApiKeyCreateDto.from_dict({
      "name": "Checkout server",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "203.0.113.0/24"
      ],
      "scopes": [
        "transactions:write",
        "transactions:refund",
        "customers",
        "tokens"
      ]
    })
    result = api.api_keys_create(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "name": "Checkout server",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "203.0.113.0/24"
  ],
  "scopes": [
    "transactions:write",
    "transactions:refund",
    "customers",
    "tokens"
  ]
}

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

Reseller back-office key

Creates a key owned by the calling reseller user for back-office automation. The key reaches only the administrative and reporting operations, is accepted only from the 198.51.100.0/24 IPv4 range and the 2001:db8::/32 IPv6 range, and stops authenticating at the expiry. It acts as its owner, so it can reach the merchants that owner manages and nothing more. The server generates the key value, so the request never carries one: the reveal operation returns it once, and the plain create returns the key without it.

cURL

curl -X POST "{{BASE_URL}}/api/api-keys" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Reseller back office",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "198.51.100.0/24",
    "2001:db8::/32"
  ],
  "scopes": [
    "admin",
    "reports"
  ]
}'

PowerShell

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

$body = @'
{
  "name": "Reseller back office",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "198.51.100.0/24",
    "2001:db8::/32"
  ],
  "scopes": [
    "admin",
    "reports"
  ]
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/api-keys' `
    -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.apiKeysCreate({
  "name": "Reseller back office",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "198.51.100.0/24",
    "2001:db8::/32"
  ],
  "scopes": [
    "admin",
    "reports"
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/api-keys', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Reseller back office",
    "expireAt": "2030-12-31",
    "allowedCidrs": [
      "198.51.100.0/24",
      "2001:db8::/32"
    ],
    "scopes": [
      "admin",
      "reports"
    ]
  }),
});

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<ApiKeyCreateDto>("""
    {
      "name": "Reseller back office",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "198.51.100.0/24",
        "2001:db8::/32"
      ],
      "scopes": [
        "admin",
        "reports"
      ]
    }
    """);

var result = await api.ApiKeysCreateAsync(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");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "Reseller back office",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "198.51.100.0/24",
        "2001:db8::/32"
      ],
      "scopes": [
        "admin",
        "reports"
      ]
    }
    """, 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.ApiKeyCreateDto.from_dict({
      "name": "Reseller back office",
      "expireAt": "2030-12-31",
      "allowedCidrs": [
        "198.51.100.0/24",
        "2001:db8::/32"
      ],
      "scopes": [
        "admin",
        "reports"
      ]
    })
    result = api.api_keys_create(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "name": "Reseller back office",
  "expireAt": "2030-12-31",
  "allowedCidrs": [
    "198.51.100.0/24",
    "2001:db8::/32"
  ],
  "scopes": [
    "admin",
    "reports"
  ]
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/api-keys",
    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

name required

string

A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service') 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.

active required

boolean

Whether the key should be active upon creation. Inactive keys cannot authenticate.

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)

Optional UTC timestamp after which the key is considered expired and 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.

allowedCidrs required

array of string array of

Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or IPv6 addresses. `null` or empty means the key is not bound to any address and may be used from anywhere, which is the default and what every existing key carries. nullablemax items 50

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. `null` or empty means the key is unrestricted, which is the default and what every existing key carries. 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

The raw API key value to be created/registered. If omitted, the server may generate it. nullablemax length 128

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)

Identifier of the user (or owner) the key belongs to

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: ApiKeyDto ApiKeyDto Each item has these fields.

Field Type Description

id required

string (uuid)

Unique identifier of the API key record

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-friendly label used to identify the key in UI and logs 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

Indicates whether the key is currently enabled for use

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)

Optional UTC timestamp when the key will expire (null means no expiration) 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)

Identifier of the user or service account that owns this 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.

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 API key

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