# GET /api/screening-providers/{providerId}/config-schema

Returns the configuration field schema for a single screening provider.

**Required permissions**: `Transactions.ScreeningProviderConfiguration.ViewSchema`  
**Scope**: merchant

**Operation ID:** `screeningProviderMetadataGetConfigSchema`

## Authorization

Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Transactions.ScreeningProviderConfiguration.ViewSchema`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| providerId | path | yes | string | The provider identifier. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

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

Schema: [`ScreeningProviderConfigSchemaDto`](https://devportal.demo.winkpg.io/docs/api/models/ScreeningProviderConfigSchemaDto.md)

Properties:
- `providerId` (string): Identifier of the screening provider this schema describes. (nullable)
- `providerName` (string): Display name of the screening provider. (nullable)
- `fields` (array<[ProcessorFieldDefinitionDto](https://devportal.demo.winkpg.io/docs/api/models/ProcessorFieldDefinitionDto.md)>): The provider's configuration fields, ordered by  `position`. (nullable)
  Fields of each item:
  - `key` (string): Stable identifier used to store and retrieve the field value. Submit this verbatim as the  `Key` of the processor field value in a merchant create/update request. (nullable)
  - `name` (string): Human-friendly label for the field. Supplying it on the corresponding field value is optional;  when omitted, the server fills it from this definition. (nullable)
  - `description` (string): Longer description or help text for the field. (nullable)
  - `displayType` ([SetupFieldDisplayType](https://devportal.demo.winkpg.io/docs/api/models/SetupFieldDisplayType.md)): Hint for how a UI should render the field (text box, toggle, or dropdown).
    Values:
    - `Toggle`
    - `TextField`
    - `Dropdown`
  - `fieldType` ([SetupFieldType](https://devportal.demo.winkpg.io/docs/api/models/SetupFieldType.md)): Underlying value type of the field (string, bool, int, datetime).
    Values:
    - `String`
    - `Bool`
    - `DateTime`
    - `Int`
  - `options` (array<[ProcessorFieldOptionDto](https://devportal.demo.winkpg.io/docs/api/models/ProcessorFieldOptionDto.md)>): For dropdown fields, the selectable options as explicit `{value, label}` pairs. Submit  the option's `Value` verbatim as the field value. When a field has no distinct backing  wire code, `Value` equals `Label`. Null for non-dropdown fields. This is the  preferred shape for closed-set fields. (nullable)
  - `dropdownList` (array<string>): For dropdown fields, the labels presented to the operator. Aligned by index with  `dropdownValues` when backing values differ from the labels. (nullable)
  - `dropdownValues` (array<string>): For dropdown fields, the backing values stored for each option. When null, the label from  `dropdownList` is also the stored value. (nullable)
  - `isRequired` (boolean): Whether a value must be supplied for this field, <b>effective for the requested payment-type  selection</b>. When the config-schema request is scoped to a set of payment types, the response  contains exactly the fields applicable to that selection and `isRequired` reflects  it, so the returned set with `IsRequired == true` is the required-field minimum for that  selection. Fields outside the selection are omitted entirely (see  `applicablePaymentTypes`).
  - `category` (string): Grouping category for UI layout (e.g. "Default", "Credit", "Debit", "EBT", "PAYFAC"). (nullable)
  - `position` (integer(int32)): Relative ordering among fields. Fields are returned ordered by this value.
  - `isSecret` (boolean): Whether the field holds a secret (credential) value. Secret values are encrypted at rest and  are never returned in plaintext; clients should treat secret fields as write-only.
  - `validationRegex` (string): Optional regular expression the submitted string value must match. (nullable)
  - `maxLength` (integer(int32)): Maximum character length for string values. Null means no limit. (nullable)
  - `validationMessage` (string): Human-readable message shown when validation fails. When null, a generic message is generated. (nullable)
  - `applicablePaymentTypes` (array<string>): Payment type <b>names</b> this field applies to: the same tokens as  `supportedPaymentTypes` and  `name`, so a client can correlate a field to a payment  type with one consistent token (no side lookup). Null or empty means the field applies to every  payment type. When a request scopes the schema to a subset of payment types, fields outside that  subset are omitted from the response. (nullable)
  - `defaultValue` (string): Optional default value pre-populated when creating a new processor profile. (nullable)
- `conflictingProcessorIds` (array<string>): Processor identifiers this provider cannot be active alongside on the same merchant. (nullable)
- `schemaVersion` (string): Opaque, deterministic content hash covering <b>everything this response carries</b>: the full  projected field catalog and the normalized `conflictingProcessorIds`. Also returned as  the response `ETag`, so a request whose `If-None-Match` matches receives  `304 Not Modified`. (nullable)

### 403

Forbidden

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

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. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `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. (nullable)
- `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## 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/screening-providers/{providerId}/config-schema" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/screening-providers/{providerId}/config-schema' `
    -Headers $headers
```

### TypeScript (SDK)

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

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

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

const { data } = await api.screeningProviderMetadataGetConfigSchema("PROVIDER_ID");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/screening-providers/{providerId}/config-schema', {
  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 ScreeningProviderMetadataApi(config);
var result = await api.ScreeningProviderMetadataGetConfigSchemaAsync("PROVIDER_ID");
```

### C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/screening-providers/{providerId}/config-schema");
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.ScreeningProviderMetadataApi(client)
    result = api.screening_provider_metadata_get_config_schema("PROVIDER_ID")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/screening-providers/{providerId}/config-schema",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

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