Screening Provider: lists the merchant's screening provider profiles.

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/merchants/{id}/screening-provider-profiles" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/{id}/screening-provider-profiles' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.merchantScreeningProviderProfileGetList("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/screening-provider-profiles', {
  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 MerchantsApi(config);
var result = await api.MerchantScreeningProviderProfileGetListAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/merchants/{id}/screening-provider-profiles");
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.MerchantsApi(client)
    result = api.merchant_screening_provider_profile_get_list("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/merchants/{id}/screening-provider-profiles",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

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

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

OK

Body: array of ScreeningProviderProfileDto array of ScreeningProviderProfileDto Each item has these fields.

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.

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)

The owning merchant. Stamped by the server; a value supplied on input is overwritten.

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.

isActive required

boolean

Whether this profile is consulted. Only an active profile participates in the exclusivity rule against the merchant's active processor profiles.

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.

configuration required

MerchantScreeningProviderConfigurationDto MerchantScreeningProviderConfigurationDto

The provider identity and its per-merchant field 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.

Fields of MerchantScreeningProviderConfigurationDto:

Field Type Description

providerId required

string

Identifier of the screening provider, matching a provider returned by the screening provider discovery endpoint. Required. 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.

providerName required

string

Display name of the provider. Optional on input; the server backfills it from the registered provider configuration. 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.

fieldValues required

array of ProcessorFieldValueDto array of ProcessorFieldValueDto

Values for the provider's configuration fields, keyed by field definition key. Values for fields the provider marks secret are encrypted at rest and are decrypted only for an authorized merchant 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.

This body has no documented fields.

reviewAction required

ScreeningReviewAction 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

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.

`Audit`	Record the review verdict on the transaction and continue to authorization. The default.
`Stop`	Treat the review verdict as a rejection: halt the flow before authorization, exactly as a provider decline does.
`HoldForReview`	Park the transaction before authorization and wait for a reviewer to dispose of it, rather than deciding the sale on the provider's behalf in either direction.

onFailureBehavior required

ScreeningFailureBehavior 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

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.

`ContinueWithAudit`	Record the non-decision on the transaction and continue to authorization. The default.
`HardStop`	Halt the transaction before authorization, with a client-safe error saying screening was unavailable. Deliberately distinct from a provider decline: nothing has judged the transaction risky, the platform simply could not ask.

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

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.

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

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.

reviewHoldExpiryAction required

ReviewHoldExpiryAction 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

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.

`Decline`	Decline the held transaction when the deadline passes, exactly as a reviewer rejection would. The default.
`ApproveAndContinue`	Release the held transaction to authorization when the deadline passes, recording that it was approved by expiry rather than by a reviewer.

This response has no documented body fields.

429 Too Many Requests

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 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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.

Fields of RemoteServiceErrorInfo:

Field Type Description

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

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

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

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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.

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 Merchants

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Screening Provider: lists the merchant's screening provider profiles.

Example request

Parameters

Request body

Responses

Errors

Authentication