WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`MerchantScreeningProviderConfigurationDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Identity of the screening provider a profile points at, plus the merchant's values for that provider's configuration fields.

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

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.

Fields of each ProcessorFieldValueDto:

Field Type Description

key required

string

Unique field key used to match with the corresponding processor field definition. Required on input. 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 UI display. Optional on input; when omitted, the server fills it from the matching processor field 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.

rawJson required

string

Raw JSON value stored for the field (the JSON token serialized as a string). Optional on input when `value` is supplied instead; the two are kept in sync. 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.

value required

any

The field value as a JSON token. Preferred input form: send the value directly (string, number, boolean, etc.) and it is round-tripped through `rawJson`. A field with no value reads as an empty object, and both that and an explicit null clear `rawJson` on the way back in, so a value read from the API can be written back unchanged.

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 model has no documented fields.