PaymentEncryptionBindingConnectionTestResultDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The outcome of probing a merchant's bound payment encryption provider.
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 | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
succeeded
required |
boolean | Gets or sets whether the provider answered the probe.
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.
| |||||||||||||||||||||||
reason
required |
string | Gets or sets a short explanation of the outcome, safe to show an operator.
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.
| |||||||||||||||||||||||
outcome
required |
string | Gets or sets the outcome as one word from a fixed vocabulary, so a caller can tell the cases apart
without parsing `reason`: `Answered`, `DidNotAnswer`, `CredentialUnavailable`
(the gateway could not load the credential the binding names, and the provider was never called),
`NotProbeable`, `NotInstalled` or `NotEnabled`.
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.
| |||||||||||||||||||||||
steps
required |
array of ConnectionTestStepDto array of ConnectionTestStepDto | Gets or sets the steps the test ran, in order. The platform always sends a list, empty when the
test ran nothing; the published schema still marks it nullable, as it does every array, so a
generated client should guard as it would any other. `succeeded` and
`reason` are not derived from this list and keep their meaning for a caller that
reads only them.
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 ConnectionTestStepDto:
This body has no documented fields. | |||||||||||||||||||||||||
This model has no documented fields.