MerchantThreeDSBinding
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-merchant 3-D Secure provider binding, one element of `Merchant.ThreeDSBindings`. The binding is independent of the acquiring processor. The directory server and access control server a card authenticates against belong to the card network, not the acquirer, so a merchant can change processor without changing 3-D Secure vendor and vice versa. Collection membership decides whether the merchant is boarded with that provider at all, and `isEnabled` decides whether it is currently switched on: the same two-level shape `MerchantDigitalWallet` uses, so a merchant can be switched off without losing credentials.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
providerType
required |
ThreeDSProviderType ThreeDSProviderType | Which 3-D Secure provider this entry binds the merchant to. A null provider type is treated
as no binding at all rather than as `Fake`, so an incompletely
boarded row cannot silently become a live selection.
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.
| ||||||
isEnabled
required |
boolean | Master enable flag for this provider on this merchant. When `false` or null, the binding
is not used even though the row exists.
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.
| ||||||
policyMode
required |
ThreeDSPolicyMode ThreeDSPolicyMode | How hard the merchant wants authentication applied. Null means the platform default, which
callers read as `Off`.
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.
| ||||||
apiKey
required |
string | The vendor API key. Not a secret in the sense the JWT secret is (it is sent as a request
header and appears as a JWT audience), so it round-trips on reads; it is still never logged.
Required: When IsEnabled is true.
nullablemax length 256
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.
| ||||||
jwtSecret
required |
string | The shared secret the request JWT is signed with.
<b>Stored encrypted.</b> It is stripped, not decrypted, on every read that leaves the server:
the admin UI and the API both see null here and re-send the secret only when the operator
changes it. Only the server-side call to the provider ever uses the plaintext.
nullablemax length 512
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.
| ||||||
jwtSecretConfigured
required |
boolean | Whether a JWT secret is stored for this binding, for the editor that is never allowed to see the
secret itself.
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.
| ||||||
endpointEnvironment
required |
ThreeDSEndpointEnvironment ThreeDSEndpointEnvironment | Which of the vendor's environments this binding points at. Null reads as
`Sandbox`.
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.
| ||||||
requestorUrl
required |
string | The merchant-facing origin the vendor validates authentication requests against: the HPP or
checkout origin the cardholder's browser is on. HTTPS only.
Conditional: When RequestorUrl is not empty.
Required: When IsEnabled is true.
nullablemax length 512
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.
| ||||||
challengeEnabled
required |
boolean | Whether the merchant permits the vendor to raise an interactive challenge. Null reads as not
enabled.
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.
| ||||||
protocolVersion
required |
string | The 3-D Secure protocol version to request, from
`SupportedProtocolVersions`. Null means the provider's own
default.
Conditional: When ProtocolVersion is not empty.
nullablemax length 16
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.
| ||||||
providerRegistrationId
required |
string (uuid) | Optional pointer at a vendor-side registration record for this merchant, for vendors that
board a merchant out of band and hand back an identifier. Nullable because most bindings
carry credentials and nothing else, and because a deleted registration should leave an
inspectable dangling reference rather than a hard failure.
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.