Returns the configuration field schema for one processor.

GET /api/processors/{processorId}/config-schema deprecated

Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.

Requires API key scope: admin (Administration)

Optionally scoped to the given payment types.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/processors/{processorId}/config-schema" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.processorMetadataGetConfigSchema("PROCESSOR_ID");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/processors/{processorId}/config-schema', {
  method: 'GET',
  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 ProcessorMetadataApi(config);
var result = await api.ProcessorMetadataGetConfigSchemaAsync("PROCESSOR_ID");

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/processors/{processorId}/config-schema");
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.ProcessorMetadataApi(client)
    result = api.processor_metadata_get_config_schema("PROCESSOR_ID")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/processors/{processorId}/config-schema",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

processorId required

path

string

The processor identifier (e.g. "tsys").

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.

paymentTypes required

query

array of string array of

Optional payment type names to filter the schema to; omit for universally-applicable fields only.

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

Body: ProcessorConfigSchemaDto ProcessorConfigSchemaDto Each item has these fields.

Field Type Description

processorId required

string

Identifier of the processor this schema describes. Submit this as the processor configuration's `ProcessorId` in a merchant create/update request. 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.

processorName required

string

Display name of the processor. 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.

fields required

array of ProcessorFieldDefinitionDto array of ProcessorFieldDefinitionDto

The fields applicable to the requested payment types, ordered by `position`. 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.

Fields of each ProcessorFieldDefinitionDto:

Field Type Description

key required

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

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.

name required

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

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.

description required

string

Longer description or help text for the field. 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.

displayType required

SetupFieldDisplayType SetupFieldDisplayType

Hint for how a UI should render the field (text box, toggle, or dropdown).

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.

`Toggle`
`TextField`
`Dropdown`

fieldType required

SetupFieldType SetupFieldType

Underlying value type of the field (string, bool, int, datetime).

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.

`String`
`Bool`
`DateTime`
`Int`

options required

array of ProcessorFieldOptionDto array of ProcessorFieldOptionDto

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

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.

dropdownList required

array of string array of

For dropdown fields, the labels presented to the operator. Aligned by index with `dropdownValues` when backing values differ from the labels. 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.

dropdownValues required

array of string array of

For dropdown fields, the backing values stored for each option. When null, the label from `dropdownList` is also the stored value. 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.

isRequired required

boolean

Whether a value must be supplied for this field, effective for the requested payment-type selection. 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`).

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.

category required

string

Grouping category for UI layout (e.g. "Default", "Credit", "Debit", "EBT", "PAYFAC"). 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.

position required

integer (int32)

Relative ordering among fields. Fields are returned ordered by this value.

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.

isSecret required

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.

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.

validationRegex required

string

Optional regular expression the submitted string value must match. 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.

maxLength required

integer (int32)

Maximum character length for string values. Null means no limit. 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.

validationMessage required

string

Human-readable message shown when validation fails. When null, a generic message is generated. 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.

applicablePaymentTypes required

array of string array of

Payment type names 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

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.

defaultValue required

string

Optional default value pre-populated when creating a new processor profile. 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.

schemaVersion required

string

Opaque, deterministic content hash of this processor's full projected field schema. It is derived from the field definitions (not hand-maintained), so it changes whenever a field is added, removed, or edited, and is stable otherwise. It is per-processor (covers the whole field catalog), so it does not vary with the `paymentTypes` filter. Cache the schema keyed by this value to detect drift; it is also returned as the response `ETag`, and a request with a matching `If-None-Match` receives `304 Not Modified`. 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.

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

Returns the configuration field schema for one processor.

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