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.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Identity and compatibility summary for a single external screening provider, as returned by the
screening provider discovery endpoint.
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
providerIdrequired
string
Identifier of the screening provider. Submit this as the screening provider profile's
`ProviderId` in a merchant create/update request.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.
providerNamerequired
string
Display name of the screening provider.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.
conflictingProcessorIdsrequired
array of stringarray of
Processor identifiers this provider cannot be active alongside on the same merchant. A merchant
save carrying both an active profile for this provider and an active processor profile for one
of these processors is rejected.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.
schemaVersionrequired
string
Opaque, deterministic content hash of this provider's projected field schema. Derived from the
field definitions, so it changes whenever a field is added, removed, or edited, and is stable
otherwise. Cache the schema keyed by this value to detect drift.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 model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.