Dry-run validates a screening provider configuration payload.

POST /api/screening-providers/{providerId}/validate-config deprecated

Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.

Writes no merchant document.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/screening-providers/{providerId}/validate-config" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "configuration": {}
}'

PowerShell

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

$body = @'
{
  "configuration": {}
}
'@

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.screeningProviderMetadataValidateConfig("PROVIDER_ID", {
  "configuration": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/screening-providers/{providerId}/validate-config', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "configuration": {}
  }),
});

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 ScreeningProviderMetadataApi(config);
var body = JsonSerializer.Deserialize<ScreeningProviderProfileDto>("""
    {
      "configuration": {}
    }
    """);

var result = await api.ScreeningProviderMetadataValidateConfigAsync("PROVIDER_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/screening-providers/{providerId}/validate-config");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "configuration": {}
    }
    """, 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.ScreeningProviderMetadataApi(client)
    body = winkpg_api.ScreeningProviderProfileDto.from_dict({
      "configuration": {}
    })
    result = api.screening_provider_metadata_validate_config("PROVIDER_ID", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "configuration": {}
}

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

Parameters

Name	In	Type	Description
`providerId` required	path	string	The provider identifier.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`screeningProviderProfileId` required	string (uuid)	Unique identifier of this screening provider profile. Server-assigned on add; any value supplied on input to the sub-resource surface is ignored.
`merchantId` required	string (uuid)	The owning merchant. Stamped by the server; a value supplied on input is overwritten.
`isActive` required	boolean	Whether this profile is consulted. Only an active profile participates in the exclusivity rule against the merchant's active processor profiles.
`configuration` required	all of MerchantScreeningProviderConfigurationDto	The provider identity and its per-merchant field values.
`reviewAction` required	all of ScreeningReviewAction	What the platform does when this provider asks for a human decision rather than answering accept or decline. Omit (or send `null`) for the default, `Audit`: record the verdict on the transaction and continue. nullable
`onFailureBehavior` required	all of ScreeningFailureBehavior	What the platform does when this provider cannot give a decision at all: a timeout, an error, an Unavailable verdict, or a skipped call because the provider's circuit breaker is open. Omit (or send `null`) for the default, `ContinueWithAudit`: record the non-decision on the transaction and continue to authorization. nullable
`timeoutMs` required	integer (int32)	How long one call to this provider may take before it is abandoned and recorded as a timeout, in milliseconds. Accepted range is `MinimumMs` to `MaximumMs`; omit for the default, `DefaultMs`. nullablemin 250max 30000
`reviewHoldDeadlineMinutes` required	integer (int32)	How long a transaction held for manual review may wait for a reviewer's disposition, in minutes. Accepted range is `MinimumDeadlineMinutes` to `MaximumDeadlineMinutes`; omit for the default, `DefaultDeadlineMinutes`. Conditional: When ReviewAction != HoldForReview. nullablemin 15max 43200
`reviewHoldExpiryAction` required	all of ReviewHoldExpiryAction	What happens to a held transaction whose deadline elapsed with no reviewer disposition. Omit (or send `null`) for the default, `Decline`: an unanswered review is not an approval. Conditional: When ReviewAction != HoldForReview. nullable

This request body has no documented fields.