ScreeningProviderProfileDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
An external screening provider configured for a merchant: which provider is consulted and the per-merchant credentials and options it needs.
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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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:
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.
| ||||||||||||
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.
| ||||||||||||
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.
| ||||||||||||
This model has no documented fields.