View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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-11-12 05:58 UTC.

API reference Models

ThreeDSecureAuthenticateResultDto

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 a 3-D Secure authentication request: either a decided outcome, or the challenge the issuer asked the cardholder to complete.

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
threeDSServerTransactionId required string The 3DS Server transaction id. Submit it as `threeDSecure.threeDSServerTransactionId` on the transaction create request once the authentication is decided. 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.
messageVersion required string The EMVCo message version the authentication ran under, for example `2.2.0`. 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.
transactionStatus required ThreeDSTransactionStatus ThreeDSTransactionStatus The transaction status the issuer reported.
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.
Unknown No status was reported, or the value could not be mapped. Treated as "no authentication happened": never liability-shifting.
Authenticated Wire value Y: authentication or account verification succeeded.
NotAuthenticated Wire value N: not authenticated, or the transaction was denied.
Unavailable Wire value U: authentication could not be performed (technical or other problem).
AttemptsProcessed Wire value A: an authentication attempt was performed and proof is supplied, but the cardholder was not actually authenticated (the "attempts" / stand-in path).
ChallengeRequired Wire value C: a cardholder challenge is required to complete authentication.
DecoupledChallengeRequired Wire value D: a decoupled cardholder challenge is required (3DS 2.2 and later).
Rejected Wire value R: authentication was rejected by the issuer.
InformationalOnly Wire value I: informational only. The 3DS requestor asked for information and no authentication was performed.
authenticated required boolean Whether the authentication is decided in the cardholder's favor. `false` while a challenge is pending, and for every status other than authenticated or attempts processed.
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.
liabilityShifted required boolean Whether the issuer shifted liability for the authentication as it stands.
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.
eci required string The electronic commerce indicator the issuer reported, when the authentication is decided. 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.
dsTransactionId required string The directory server transaction id, when the issuer reported one. 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.
transactionStatusReason required string The issuer's reason for the status, when it gave one. 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.
challenge required ThreeDSecureChallengeDto ThreeDSecureChallengeDto The challenge to present to the cardholder, when the issuer asked for one. Absent when the authentication is decided without a challenge.
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 ThreeDSecureChallengeDto:

Field Type Description
acsUrl required string The access control server URL the challenge form posts to. 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.
encodedChallengeRequest required string The encoded challenge request to post as the `creq` field. 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.
sessionData required string The session data to post as `threeDSSessionData`, when the vendor supplies one. 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.
challengeWindowSize required ThreeDSChallengeWindowSize ThreeDSChallengeWindowSize The window size the challenge request declared.
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.
Size250X400 Wire value 01: 250 x 400.
Size390X400 Wire value 02: 390 x 400.
Size500X600 Wire value 03: 500 x 600.
Size600X400 Wire value 04: 600 x 400.
FullScreen Wire value 05: full screen.
acsTransactionId required string The access control server transaction id, for the caller's own correlation. 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 body has no documented fields.

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.