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.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
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.
Parameters
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.
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 request body has no documented fields.
Responses
200 OK
Body:
ProcessorConfigValidationResultDto
ProcessorConfigValidationResultDto
Each item has these fields.
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
isValid
required |
boolean | True when every applicable field passed validation (no `results` entry has
`ok` == false).
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.
| ||||||||||||
results
required |
array of ProcessorFieldValidationResultDto array of ProcessorFieldValidationResultDto | One entry per field that was evaluated for the requested payment-type selection. Fields outside
the selection are not evaluated and are omitted.
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 ProcessorFieldValidationResultDto:
This body has no documented fields. | ||||||||||||||
This response has no documented body fields.
403 Forbidden
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.
401 Unauthorized
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.
400 Bad Request
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.
404 Not Found
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.
501 Not Implemented
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.
500 Internal Server Error
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.
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.
|
This response has no documented body fields.
429 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
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.