Payment encryption: retires one key entry.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/deactivate" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/deactivate' `
    -Headers $headers

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.merchantPaymentEncryptionBindingDeactivatePaymentEncryptionKeyEntry("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", "KSI");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/deactivate', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new MerchantPaymentEncryptionBindingApi(config);
var result = await api.MerchantPaymentEncryptionBindingDeactivatePaymentEncryptionKeyEntryAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", "KSI");

C# (raw HTTP)

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

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

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)
    result = api.merchant_payment_encryption_binding_deactivate_payment_encryption_key_entry("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", "KSI")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/deactivate",
    headers=headers,
)
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 retire.

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

This request body has no documented fields.

Responses

200 OK

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

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 response has no documented body fields.

429 Too Many Requests

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 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

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.

message required

string

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.

details required

string

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.

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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 body has no documented fields.

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

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Payment encryption: retires one key entry.

Example request

Parameters

Request body

Responses

Errors

Authentication