Payment encryption: creates or replaces the merchant's binding for one provider.

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

Requires: Merchants.Merchants.Update, merchant scope.

Example body for a merchant on its own HSM contract, with one TDES DUKPT device family: ``` { "isEnabled": true, "credentialSource": "Merchant", "primaryEndpoint": "https://example-region-a.invalid", "secondaryEndpoint": "https://example-region-b.invalid", "fieldValues": [ { "key": "PaymentEncryption.Example.ClientId", "value": "…" }, { "key": "PaymentEncryption.Example.ClientSecret", "value": "…" } ], "keyEntries": [ { "ksi": "0102030405", "label": "Lane terminals, store 14", "scheme": "Dukpt", "dukptMode": "Tdes", "keyReference": "…", "status": "Active" } ] } ``` For a provider the gateway holds the account for, send `"credentialSource": "Gateway"` and no field values at all: the gateway's own credentials are resolved at decryption time and are never copied onto the merchant. Key entries are the merchant's either way. Omitting a secret, or a key entry's `keyReference`, keeps the value already stored, which is what a caller that read the binding first will naturally send, because reads never return one. A key entry the body omits entirely is <em>removed</em>: a key dropped from the table is a deliberate removal, unlike an omitted secret. Optionally send `If-Match: "<concurrencyStamp>"` for optimistic concurrency (409 on a stale stamp).

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 MerchantPaymentEncryptionBinding. 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}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "keyEntries": [
    {
      "ksi": ""
    }
  ],
  "primaryEndpoint": "",
  "secondaryEndpoint": "",
  "decryptTimeoutMillisecondsOverride": 0
}'

PowerShell

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

$body = @'
{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "keyEntries": [
    {
      "ksi": ""
    }
  ],
  "primaryEndpoint": "",
  "secondaryEndpoint": "",
  "decryptTimeoutMillisecondsOverride": 0
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}' `
    -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.merchantPaymentEncryptionBindingUpsertPaymentEncryptionBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", {
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "keyEntries": [
    {
      "ksi": ""
    }
  ],
  "primaryEndpoint": "",
  "secondaryEndpoint": "",
  "decryptTimeoutMillisecondsOverride": 0
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "providerName": "",
    "isEnabled": false,
    "credentialSource": {},
    "fieldValues": [
      {
        "key": "",
        "value": "",
        "isSecret": false,
        "isConfigured": false
      }
    ],
    "keyEntries": [
      {
        "ksi": ""
      }
    ],
    "primaryEndpoint": "",
    "secondaryEndpoint": "",
    "decryptTimeoutMillisecondsOverride": 0
  }),
});

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<MerchantPaymentEncryptionBinding>("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ],
      "keyEntries": [
        {
          "ksi": ""
        }
      ],
      "primaryEndpoint": "",
      "secondaryEndpoint": "",
      "decryptTimeoutMillisecondsOverride": 0
    }
    """);

var result = await api.MerchantPaymentEncryptionBindingUpsertPaymentEncryptionBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", 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}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ],
      "keyEntries": [
        {
          "ksi": ""
        }
      ],
      "primaryEndpoint": "",
      "secondaryEndpoint": "",
      "decryptTimeoutMillisecondsOverride": 0
    }
    """, 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.MerchantPaymentEncryptionBinding.from_dict({
      "providerName": "",
      "isEnabled": False,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": False,
          "isConfigured": False
        }
      ],
      "keyEntries": [
        {
          "ksi": ""
        }
      ],
      "primaryEndpoint": "",
      "secondaryEndpoint": "",
      "decryptTimeoutMillisecondsOverride": 0
    })
    result = api.merchant_payment_encryption_binding_upsert_payment_encryption_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "providerName": "",
  "isEnabled": False,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": False,
      "isConfigured": False
    }
  ],
  "keyEntries": [
    {
      "ksi": ""
    }
  ],
  "primaryEndpoint": "",
  "secondaryEndpoint": "",
  "decryptTimeoutMillisecondsOverride": 0
}

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

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The merchant id.
`providerName` required	path	string	The provider to bind (authoritative; any provider on the body is ignored).
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`providerName` required	string	Which payment encryption provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely boarded row cannot silently become a live selection. Required: When IsEnabled is true. nullablemax length 64
`isEnabled` required	boolean	Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. nullable
`credentialSource` required	all of PaymentEncryptionCredentialSource	Whose provider account the decryption calls are billed to. Null reads as `Gateway`. nullable
`fieldValues` required	array of PaymentEncryptionBindingFieldValue	The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. <b>Secret values are stored encrypted</b> and are stripped, not decrypted, on every read that leaves the server. Only the server-side call to the provider ever uses the plaintext. Empty for a `Gateway` binding, whose values are filled in at read time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be a copy of the gateway's credentials living on a merchant document. Conditional: When FieldValues is not null. nullable
`keyEntries` required	array of PaymentEncryptionKeyEntry	The key serial identifier entries that map an inbound key serial number to an HSM key. Conditional: When KeyEntries is not null. nullable
`primaryEndpoint` required	string	The primary provider endpoint for this merchant, or null to use the provider's own configured endpoint. HTTPS-only, enforced by the binding validator. Conditional: When PrimaryEndpoint is not empty. nullablemax length 512
`secondaryEndpoint` required	string	The secondary provider endpoint, used when the primary does not answer. HTTPS-only. Null when the merchant is bound to one region only. Conditional: When SecondaryEndpoint is not empty. Conditional: When SecondaryEndpoint is not empty and PrimaryEndpoint is empty. nullablemax length 512
`decryptTimeoutMillisecondsOverride` required	integer (int32)	A per-merchant override of the gateway-wide decryption budget, in milliseconds, or null to use the gateway setting. Conditional: When DecryptTimeoutMillisecondsOverride is not null. Range: 250 to 30000. nullable

This request body has no documented fields.