Returns a ready-to-fill processor profile skeleton.

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

Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.

Requires API key scope: admin (Administration)

Built for the given processor and payment-type selection, and suitable for dropping into `processing.processorProfiles[]` on a merchant create or update.

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/template" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/processors/{processorId}/config-schema/template' `
    -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.processorMetadataGetConfigTemplate("PROCESSOR_ID");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/processors/{processorId}/config-schema/template', {
  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.ProcessorMetadataGetConfigTemplateAsync("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/template");
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_template("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/template",
    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

Payment type names to scope the template 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.

includeOptional required

query

boolean

When false (default), only required and defaulted fields are emitted; when true, all applicable fields are emitted.

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: ProcessorProfileDto ProcessorProfileDto Each item has these fields.

Field Type Description

processorProfileId required

string (uuid)

Gets or sets the unique identifier of this processor profile.

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.

merchantId required

string (uuid)

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

paymentTypes required

array of ProcessorProfilePaymentType array of ProcessorProfilePaymentType

Payment types turned on for this 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.

Fields of each ProcessorProfilePaymentType:

Field Type Description

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

name required

string

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.

isActive required

boolean

Shows if the current profile is active or not.

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.

enabledTenders required

TenderEnableFlags TenderEnableFlags

Per-tender enable flags applied by the capability cascade at the processor-account layer. `null` indicates "all disabled" for legacy profiles that have never opted in to a non-credit tender.

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 TenderEnableFlags:

Field Type Description

ebtSnap required

boolean

Whether `EbtSnap` is enabled at this layer.

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.

ebtCash required

boolean

Whether `EbtCash` is enabled at this layer.

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.

ewic required

boolean

Whether `Ewic` is enabled at this layer.

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.

merchantProcessorConfiguration required

MerchantProcessorConfigurationDto MerchantProcessorConfigurationDto

Corresponding configuration holding the details of the processor.

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 MerchantProcessorConfigurationDto:

Field Type Description

processorId required

string

Identifier of the processor. Use a value returned by the processor discovery endpoint (`GET /api/processors`), e.g. "tsys". 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

Name of the processor. Optional on input; informational. 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.

processorFieldValues required

array of ProcessorFieldValueDto array of ProcessorFieldValueDto

Values for the processor's configuration fields, keyed by the field definition's `Key`. Discover the expected keys via the processor config-schema endpoint. 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.

merchantConcurrencyStamp required

string

The merchant's concurrency stamp after the write that returned this profile, or `null` on a read. 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.

datawireRegistration required

ProcessorProfileDatawireRegistrationDto ProcessorProfileDatawireRegistrationDto

What automatic Datawire registration did during the write that returned this profile. Absent when it did not run (any non-Fiserv profile, a Fiserv profile that already carries a Datawire ID, and every read).

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 ProcessorProfileDatawireRegistrationDto:

Field Type Description

outcome required

string

The outcome name: one of the `DatawireRegistrationOutcome` values (`Registered`, `AlreadyProvisioned`, `Failed`, `ConfigurationError`, `RegisteredNotPersisted`), or `FaultedOutcome`. 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.

message required

string

A message written for the operator reading it, never a raw processor payload. Says what to do next where there is something to do. 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.

datawireId required

string

The Datawire ID that was issued but could not be written onto the profile, and only that. 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.

webhookRegistrationToken required

string

The token in this profile's webhook registration URL, for a processor whose provider sends webhooks to a URL registered per merchant. Absent for every other 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.

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 a ready-to-fill processor profile skeleton.

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