Dry-run validates a processor configuration payload.

POST /api/processors/{processorId}/validate-config deprecated

Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.

Writes no merchant document, so a client can confirm a payload before submitting it.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/processors/{processorId}/validate-config" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
  ],
  "isActive": false,
  "enabledTenders": {},
  "merchantProcessorConfiguration": {},
  "merchantConcurrencyStamp": "",
  "datawireRegistration": {},
  "webhookRegistrationToken": ""
}'

PowerShell

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

$body = @'
{
  "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
  ],
  "isActive": false,
  "enabledTenders": {},
  "merchantProcessorConfiguration": {},
  "merchantConcurrencyStamp": "",
  "datawireRegistration": {},
  "webhookRegistrationToken": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/processors/{processorId}/validate-config' `
    -Headers $headers -ContentType 'application/json' -Body $body

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.processorMetadataValidateConfig("PROCESSOR_ID", {
  "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
  ],
  "isActive": false,
  "enabledTenders": {},
  "merchantProcessorConfiguration": {},
  "merchantConcurrencyStamp": "",
  "datawireRegistration": {},
  "webhookRegistrationToken": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/processors/{processorId}/validate-config', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentTypes": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": ""
      }
    ],
    "isActive": false,
    "enabledTenders": {},
    "merchantProcessorConfiguration": {},
    "merchantConcurrencyStamp": "",
    "datawireRegistration": {},
    "webhookRegistrationToken": ""
  }),
});

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 ProcessorMetadataApi(config);
var body = JsonSerializer.Deserialize<ProcessorProfileDto>("""
    {
      "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": ""
        }
      ],
      "isActive": false,
      "enabledTenders": {},
      "merchantProcessorConfiguration": {},
      "merchantConcurrencyStamp": "",
      "datawireRegistration": {},
      "webhookRegistrationToken": ""
    }
    """);

var result = await api.ProcessorMetadataValidateConfigAsync("PROCESSOR_ID", body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/processors/{processorId}/validate-config");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": ""
        }
      ],
      "isActive": false,
      "enabledTenders": {},
      "merchantProcessorConfiguration": {},
      "merchantConcurrencyStamp": "",
      "datawireRegistration": {},
      "webhookRegistrationToken": ""
    }
    """, 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.ProcessorMetadataApi(client)
    body = winkpg_api.ProcessorProfileDto.from_dict({
      "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": ""
        }
      ],
      "isActive": False,
      "enabledTenders": {},
      "merchantProcessorConfiguration": {},
      "merchantConcurrencyStamp": "",
      "datawireRegistration": {},
      "webhookRegistrationToken": ""
    })
    result = api.processor_metadata_validate_config("PROCESSOR_ID", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
  ],
  "isActive": False,
  "enabledTenders": {},
  "merchantProcessorConfiguration": {},
  "merchantConcurrencyStamp": "",
  "datawireRegistration": {},
  "webhookRegistrationToken": ""
}

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

Parameters

Name	In	Type	Description
`processorId` required	path	string	The processor identifier (e.g. "tsys").
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`processorProfileId` required	string (uuid)	Gets or sets the unique identifier of this processor profile.
`merchantId` required	string (uuid)	Corresponding merchant id
`paymentTypes` required	array of ProcessorProfilePaymentType	Payment types turned on for this profile. nullable
`isActive` required	boolean	Shows if the current profile is active or not.
`enabledTenders` required	all of 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.
`merchantProcessorConfiguration` required	all of MerchantProcessorConfigurationDto	Corresponding configuration holding the details of the processor.
`merchantConcurrencyStamp` required	string	The merchant's concurrency stamp after the write that returned this profile, or `null` on a read. nullable
`datawireRegistration` required	all of 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).
`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

This request body has no documented fields.