# GET /api/merchants/{id}/three-d-secure-bindings/{providerType}

3-D Secure: gets the merchant's binding for one provider.

**Required permissions**: `Merchants`  
**Scope**: merchant

**Operation ID:** `merchantThreeDSBindingGetThreeDSBinding`

## Authorization

Requires: Merchants.Merchants, merchant scope.

Required permissions:
- `Merchants.Merchants`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The merchant id. |
| providerType | path | yes | ThreeDSProviderType | The provider whose binding to read. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `MerchantThreeDSBinding`

Properties:
- `providerType` (object): 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.
- `isEnabled` (boolean): Master enable flag for this provider on this merchant. When `false` or null, the binding  is not used even though the row exists.
- `policyMode` (object): How hard the merchant wants authentication applied. Null means the platform default, which  callers read as `Off`.
- `apiKey` (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.
- `jwtSecret` (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.
- `jwtSecretConfigured` (boolean): Whether a JWT secret is stored for this binding, for the editor that is never allowed to see the  secret itself.
- `endpointEnvironment` (object): Which of the vendor's environments this binding points at. Null reads as  `Sandbox`.
- `requestorUrl` (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.
- `challengeEnabled` (boolean): Whether the merchant permits the vendor to raise an interactive challenge. Null reads as not  enabled.
- `protocolVersion` (string): The 3-D Secure protocol version to request, from  `SupportedProtocolVersions`. Null means the provider's own  default. Conditional: When ProtocolVersion is not empty.
- `providerRegistrationId` (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.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

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

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

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

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

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

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

const { data } = await api.merchantThreeDSBindingGetThreeDSBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_TYPE");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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 MerchantThreeDSBindingApi(config);
var result = await api.MerchantThreeDSBindingGetThreeDSBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_TYPE");
```

### C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/merchants/{id}/three-d-secure-bindings/{providerType}");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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)
    result = api.merchant_three_ds_binding_get_three_ds_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_TYPE")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/merchants/{id}/three-d-secure-bindings/{providerType}",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.