3-D Secure: creates or replaces the merchant's binding for one provider.

PUT /api/merchants/{id}/three-d-secure-bindings/{providerType} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Requires API key scope: admin (Administration)

Example body: ``` { "isEnabled": true, "policyMode": "Attempt", "apiKey": "…", "jwtSecret": "…", "endpointEnvironment": "Sandbox", "requestorUrl": "https://checkout.example.com", "challengeEnabled": true, "protocolVersion": "2.2.0" } ``` Omitting `jwtSecret` keeps the secret already stored, which is what a caller that read the binding first will naturally send, because reads never return it. 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 MerchantThreeDSBinding. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "providerType": {},
  "isEnabled": false,
  "policyMode": {},
  "apiKey": "",
  "jwtSecret": "",
  "jwtSecretConfigured": false,
  "endpointEnvironment": {},
  "requestorUrl": "",
  "challengeEnabled": false,
  "protocolVersion": "",
  "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

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

$body = @'
{
  "providerType": {},
  "isEnabled": false,
  "policyMode": {},
  "apiKey": "",
  "jwtSecret": "",
  "jwtSecretConfigured": false,
  "endpointEnvironment": {},
  "requestorUrl": "",
  "challengeEnabled": false,
  "protocolVersion": "",
  "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.merchantThreeDSBindingUpsertThreeDSBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_TYPE", {
  "providerType": {},
  "isEnabled": false,
  "policyMode": {},
  "apiKey": "",
  "jwtSecret": "",
  "jwtSecretConfigured": false,
  "endpointEnvironment": {},
  "requestorUrl": "",
  "challengeEnabled": false,
  "protocolVersion": "",
  "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "providerType": {},
    "isEnabled": false,
    "policyMode": {},
    "apiKey": "",
    "jwtSecret": "",
    "jwtSecretConfigured": false,
    "endpointEnvironment": {},
    "requestorUrl": "",
    "challengeEnabled": false,
    "protocolVersion": "",
    "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

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 MerchantThreeDSBindingApi(config);
var body = JsonSerializer.Deserialize<MerchantThreeDSBinding>("""
    {
      "providerType": {},
      "isEnabled": false,
      "policyMode": {},
      "apiKey": "",
      "jwtSecret": "",
      "jwtSecretConfigured": false,
      "endpointEnvironment": {},
      "requestorUrl": "",
      "challengeEnabled": false,
      "protocolVersion": "",
      "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.MerchantThreeDSBindingUpsertThreeDSBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_TYPE", 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}/three-d-secure-bindings/{providerType}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "providerType": {},
      "isEnabled": false,
      "policyMode": {},
      "apiKey": "",
      "jwtSecret": "",
      "jwtSecretConfigured": false,
      "endpointEnvironment": {},
      "requestorUrl": "",
      "challengeEnabled": false,
      "protocolVersion": "",
      "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, 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.MerchantThreeDSBindingApi(client)
    body = winkpg_api.MerchantThreeDSBinding.from_dict({
      "providerType": {},
      "isEnabled": False,
      "policyMode": {},
      "apiKey": "",
      "jwtSecret": "",
      "jwtSecretConfigured": False,
      "endpointEnvironment": {},
      "requestorUrl": "",
      "challengeEnabled": False,
      "protocolVersion": "",
      "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.merchant_three_ds_binding_upsert_three_ds_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_TYPE", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "providerType": {},
  "isEnabled": False,
  "policyMode": {},
  "apiKey": "",
  "jwtSecret": "",
  "jwtSecretConfigured": False,
  "endpointEnvironment": {},
  "requestorUrl": "",
  "challengeEnabled": False,
  "protocolVersion": "",
  "providerRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}",
    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.

providerType required

path

ThreeDSProviderType ThreeDSProviderType

The provider to bind (authoritative; any provider 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.

`Fake`	Deterministic in-memory provider that performs no network calls. The local-dev, CI, and default-selection provider, and the safe landing spot for an absent configuration value.
`Paay`	Paay (API brand "3DS Integrator"), reached over its Direct API. Supports authentication, the 3DS Method step, the cardholder challenge, and 3RI; it documents no decoupled or Secure Payment Confirmation capability, so the registry refuses those.

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

providerType required

ThreeDSProviderType ThreeDSProviderType

Which 3-D Secure provider this entry binds the merchant to. A null provider type is treated as no binding at all rather than as `Fake`, so an incompletely boarded row cannot silently become a live selection. 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.

`Fake`	Deterministic in-memory provider that performs no network calls. The local-dev, CI, and default-selection provider, and the safe landing spot for an absent configuration value.
`Paay`	Paay (API brand "3DS Integrator"), reached over its Direct API. Supports authentication, the 3DS Method step, the cardholder challenge, and 3RI; it documents no decoupled or Secure Payment Confirmation capability, so the registry refuses those.

isEnabled required

boolean

Master enable flag for this provider on this merchant. When `false` or null, the binding is not used even though the row exists. 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.

policyMode required

ThreeDSPolicyMode ThreeDSPolicyMode

How hard the merchant wants authentication applied. Null means the platform default, which callers read as `Off`. 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.

`Off`	Do not attempt 3-D Secure at all. The safe landing spot for an absent stored value.
`Attempt`	Attempt authentication, but continue with the payment when it cannot be completed. Liability shift is taken where the issuer grants it and forgone where it does not.
`Require`	Attempt authentication and refuse the payment when it cannot be completed. The merchant has chosen never to process an unauthenticated transaction on the surfaces this applies to.

apiKey required

string

The vendor API key. Not a secret in the sense the JWT secret is (it is sent as a request header and appears as a JWT audience), so it round-trips on reads; it is still never logged. Required: When IsEnabled is true. nullablemax length 256

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.

jwtSecret required

string

The shared secret the request JWT is signed with. <b>Stored encrypted.</b> It is stripped, not decrypted, on every read that leaves the server: the admin UI and the API both see null here and re-send the secret only when the operator changes it. Only the server-side call to the provider ever uses the plaintext. nullablemax length 512

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.

jwtSecretConfigured required

boolean

Whether a JWT secret is stored for this binding, for the editor that is never allowed to see the secret itself. 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.

endpointEnvironment required

ThreeDSEndpointEnvironment ThreeDSEndpointEnvironment

Which of the vendor's environments this binding points at. Null reads as `Sandbox`. 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.

`Sandbox`	The vendor's test environment. The safe landing spot for an absent stored value.
`Live`	The vendor's production environment.

requestorUrl required

string

The merchant-facing origin the vendor validates authentication requests against: the HPP or checkout origin the cardholder's browser is on. HTTPS only. Conditional: When RequestorUrl is not empty. Required: When IsEnabled is true. nullablemax length 512

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.

challengeEnabled required

boolean

Whether the merchant permits the vendor to raise an interactive challenge. Null reads as not enabled. 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.

protocolVersion required

string

The 3-D Secure protocol version to request, from `SupportedProtocolVersions`. Null means the provider's own default. Conditional: When ProtocolVersion is not empty. 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.

providerRegistrationId required

string (uuid)

Optional pointer at a vendor-side registration record for this merchant, for vendors that board a merchant out of band and hand back an identifier. Nullable because most bindings carry credentials and nothing else, and because a deleted registration should leave an inspectable dangling reference rather than a hard failure. 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: MerchantThreeDSBinding MerchantThreeDSBinding Each item has these fields.

Field Type Description

providerType required

ThreeDSProviderType ThreeDSProviderType

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.

`Fake`	Deterministic in-memory provider that performs no network calls. The local-dev, CI, and default-selection provider, and the safe landing spot for an absent configuration value.
`Paay`	Paay (API brand "3DS Integrator"), reached over its Direct API. Supports authentication, the 3DS Method step, the cardholder challenge, and 3RI; it documents no decoupled or Secure Payment Confirmation capability, so the registry refuses those.

isEnabled required

boolean

Master enable flag for this provider on this merchant. When `false` or null, the binding is not used even though the row exists. 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.

policyMode required

ThreeDSPolicyMode ThreeDSPolicyMode

How hard the merchant wants authentication applied. Null means the platform default, which callers read as `Off`. 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.

`Off`	Do not attempt 3-D Secure at all. The safe landing spot for an absent stored value.
`Attempt`	Attempt authentication, but continue with the payment when it cannot be completed. Liability shift is taken where the issuer grants it and forgone where it does not.
`Require`	Attempt authentication and refuse the payment when it cannot be completed. The merchant has chosen never to process an unauthenticated transaction on the surfaces this applies to.

apiKey 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.

jwtSecret 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.

jwtSecretConfigured required

boolean

Whether a JWT secret is stored for this binding, for the editor that is never allowed to see the secret itself. 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.

endpointEnvironment required

ThreeDSEndpointEnvironment ThreeDSEndpointEnvironment

Which of the vendor's environments this binding points at. Null reads as `Sandbox`. 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.

`Sandbox`	The vendor's test environment. The safe landing spot for an absent stored value.
`Live`	The vendor's production environment.

requestorUrl 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.

challengeEnabled required

boolean

Whether the merchant permits the vendor to raise an interactive challenge. Null reads as not enabled. 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.

protocolVersion required

string

The 3-D Secure protocol version to request, from `SupportedProtocolVersions`. Null means the provider's own default. Conditional: When ProtocolVersion is not empty. 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.

providerRegistrationId 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.

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

3-D Secure: creates or replaces the merchant's binding for one provider.

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