Payment encryption: adds or replaces one key entry.

PUT /api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Requires API key scope: admin (Administration)

A key entry verb rather than a whole-binding save, so rotating one device family's key does not require sending the provider credentials back. The binding must already exist. Omitting `keyReference` keeps the stored one. `createdAtUtc`, `statusChangedAtUtc` and `isKeyReferenceConfigured` are server-owned and ignored on the body. An omitted `status` is stored as `Active` on a new entry and keeps the stored status on a replace, so correcting a retired key's label cannot return it to service: use the reactivate endpoint for that. Optionally send `If-Match: "<concurrencyStamp>"`.

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 PaymentEncryptionKeyEntry. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ksi": ""
}'

PowerShell

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

$body = @'
{
  "ksi": ""
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.merchantPaymentEncryptionBindingUpsertPaymentEncryptionKeyEntry("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", "KSI", {
  "ksi": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ksi": ""
  }),
});

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 MerchantPaymentEncryptionBindingApi(config);
var body = JsonSerializer.Deserialize<PaymentEncryptionKeyEntry>("""
    {
      "ksi": ""
    }
    """);

var result = await api.MerchantPaymentEncryptionBindingUpsertPaymentEncryptionKeyEntryAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", "KSI", body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "ksi": ""
    }
    """, 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.MerchantPaymentEncryptionBindingApi(client)
    body = winkpg_api.PaymentEncryptionKeyEntry.from_dict({
      "ksi": ""
    })
    result = api.merchant_payment_encryption_binding_upsert_payment_encryption_key_entry("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", "KSI", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "ksi": ""
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

The merchant id.

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.

providerName required

path

string

The provider whose binding holds the key table.

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.

ksi required

path

string

The key serial identifier to write (authoritative; any KSI on the body is ignored).

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.

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

ksi required

string

The key serial identifier: six to ten significant hex characters, stored upper-case with leading `F` padding stripped. Unique within a binding. Conditional: When Ksi is not empty. 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.

label required

string

An operator-facing label for this key, such as the device family it was injected into. Shown wherever the key reference itself must not be. nullablemax length 100

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.

scheme required

PaymentEncryptionScheme PaymentEncryptionScheme

Which encryption scheme the terminals under this key produce. Required: When Status != Deactivated. 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.

`Dukpt`	Generic DUKPT (ANSI X9.24 data variant), TDES or AES.
`OnGuard`	The Ingenico On-Guard protocol.

dukptMode required

PaymentEncryptionDukptMode PaymentEncryptionDukptMode

The DUKPT key derivation algorithm this key uses. 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.

`Tdes`	Triple DES DUKPT (ANSI X9.24 Part 1).
`Aes`	AES DUKPT (ANSI X9.24 Part 3). Carries a working-key type alongside it.

aesWorkingKeyType required

string

The AES working-key type, required when `dukptMode` is `Aes` and meaningless otherwise. A provider token value rather than an enum, because the vocabulary belongs to the vendor's command set. Required: When DukptMode == Aes. Conditional: When DukptMode is not null and DukptMode != Aes. nullablemax length 16

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.

keyReference required

string

The HSM key reference: a storage-table slot or a wrapped key block. <b>Always stored encrypted, and never returned on a read that leaves the server.</b> nullablemax length 1024

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.

isKeyReferenceConfigured required

boolean

Whether a key reference is stored, set on reads so an operator can tell a configured key from an empty one without the reference ever being sent. Server-owned: the save paths ignore whatever arrives here. 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.

majorKey required

string

The major key the reference is stored under, in the provider's own token vocabulary. Null leaves the provider's default in force. nullablemax length 16

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.

onGuardExtendedEncryption required

boolean

On-Guard extended encryption, when the device family uses it. Meaningful only when `scheme` is `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. 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.

onGuardEndingPanDigitsEncrypted required

boolean

Whether the device family encrypts the ending PAN digits. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. 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.

onGuardClearPanDigits required

integer (int32)

How many leading PAN digits the device family leaves in the clear. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. Conditional: When OnGuardClearPanDigits is not null. Range: 0 to 6. 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.

status required

PaymentEncryptionKeyEntryStatus PaymentEncryptionKeyEntryStatus

Whether the entry may be matched. Null reads as `Deactivated`: an entry whose status nobody set has not been through the boarding step that activates it, and matching it would use a key the platform cannot confirm is live. 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`	The entry may be matched against an inbound key serial number.
`Deactivated`	The entry is retired. It stays readable for explaining past transactions, and is never matched.

requireMac required

boolean

Reserved: whether the device family attaches a MAC that should be verified during decryption. 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.

createdAtUtc required

string (date-time)

When the entry was created, in UTC. 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.

statusChangedAtUtc required

string (date-time)

When `status` last changed, in UTC. Separate from the audit log because it is shown on the key table itself, where an operator decides whether a key is still in 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.

This request body has no documented fields.

Responses

200 OK

Body: PaymentEncryptionKeyEntry PaymentEncryptionKeyEntry Each item has these fields.

Field Type Description

ksi required

string

The key serial identifier: six to ten significant hex characters, stored upper-case with leading `F` padding stripped. Unique within a binding. Conditional: When Ksi is not empty. 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.

label required

string

An operator-facing label for this key, such as the device family it was injected into. Shown wherever the key reference itself must not be. nullablemax length 100

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.

scheme required

PaymentEncryptionScheme PaymentEncryptionScheme

Which encryption scheme the terminals under this key produce. Required: When Status != Deactivated. 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.

`Dukpt`	Generic DUKPT (ANSI X9.24 data variant), TDES or AES.
`OnGuard`	The Ingenico On-Guard protocol.

dukptMode required

PaymentEncryptionDukptMode PaymentEncryptionDukptMode

The DUKPT key derivation algorithm this key uses. 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.

`Tdes`	Triple DES DUKPT (ANSI X9.24 Part 1).
`Aes`	AES DUKPT (ANSI X9.24 Part 3). Carries a working-key type alongside it.

aesWorkingKeyType required

string

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.

keyReference required

string

The HSM key reference: a storage-table slot or a wrapped key block. <b>Always stored encrypted, and never returned on a read that leaves the server.</b> nullablemax length 1024

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.

isKeyReferenceConfigured required

boolean

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.

majorKey required

string

The major key the reference is stored under, in the provider's own token vocabulary. Null leaves the provider's default in force. nullablemax length 16

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.

onGuardExtendedEncryption required

boolean

On-Guard extended encryption, when the device family uses it. Meaningful only when `scheme` is `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. 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.

onGuardEndingPanDigitsEncrypted required

boolean

Whether the device family encrypts the ending PAN digits. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. 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.

onGuardClearPanDigits required

integer (int32)

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.

status required

PaymentEncryptionKeyEntryStatus PaymentEncryptionKeyEntryStatus

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 entry may be matched against an inbound key serial number.
`Deactivated`	The entry is retired. It stays readable for explaining past transactions, and is never matched.

requireMac required

boolean

Reserved: whether the device family attaches a MAC that should be verified during decryption. 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.

createdAtUtc required

string (date-time)

When the entry was created, in UTC. 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.

statusChangedAtUtc required

string (date-time)

When `status` last changed, in UTC. Separate from the audit log because it is shown on the key table itself, where an operator decides whether a key is still in 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.

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

Payment encryption: adds or replaces one key entry.

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