Enum TransactionState 

pub enum TransactionState {
    Created {
        areq: Box<AuthenticationRequest>,
    },
    AwaitingARes {
        three_ds_server_trans_id: String,
    },
    AwaitingCRes {
        three_ds_server_trans_id: String,
        acs_trans_id: String,
        acs_url: Option<String>,
    },
    AwaitingRReq {
        three_ds_server_trans_id: String,
        acs_trans_id: String,
    },
    Authenticated {
        three_ds_server_trans_id: String,
        acs_trans_id: String,
        ds_trans_id: Option<String>,
        eci: Option<Eci>,
        authentication_value: Option<String>,
    },
    NotAuthenticated {
        three_ds_server_trans_id: String,
        trans_status: TransStatus,
        reason_code: Option<String>,
    },
    Failed {
        error: String,
    },
}

The lifecycle of a single 3DS transaction as seen by the 3DS Server.

Transitions are driven by sending an AReq and receiving subsequent messages. Terminal states are Authenticated, NotAuthenticated, and Failed.

 Created
   │  send_areq()
   ▼
 AwaitingARes
   │  receive_ares()
   ├─(Y/A)──────────────────────► Authenticated
   ├─(N/U/R)────────────────────► NotAuthenticated
   ├─(C)
   │    │
   │    ▼
   │  AwaitingCRes
   │    │  receive_cres()
   │    ├─(Y/A)────────────────► Authenticated
   │    └─(N/U)────────────────► NotAuthenticated
   └─(D)
        │
        ▼
      AwaitingRReq
        │  receive_rreq()
        ├─(Y/A)──────────────────► Authenticated
        └─(N/U/R)────────────────► NotAuthenticated

 Any state + receive_error() ──► Failed

Variants

Created

AReq has been constructed and is ready to send.

Fields

areq: Box<AuthenticationRequest>

AwaitingARes

AReq sent; waiting for the ARes from the DS.

Fields

three_ds_server_trans_id: String

AwaitingCRes

ARes received with transStatus=C; challenge must be presented.

Fields

three_ds_server_trans_id: String

acs_trans_id: String

acs_url: Option<String>

ACS URL to redirect/embed (browser channel), or None for app/decoupled.

AwaitingRReq

ARes received with transStatus=D; waiting for the ACS to send an RReq after completing decoupled out-of-band authentication.

Fields

three_ds_server_trans_id: String

acs_trans_id: String

Authenticated

Authentication completed successfully (frictionless Y/A or challenge Y).

Fields

three_ds_server_trans_id: String

acs_trans_id: String

ds_trans_id: Option<String>

eci: Option<Eci>

authentication_value: Option<String>

CAVV / AAV value to include in the authorization request.

NotAuthenticated

Authentication was rejected or failed (N, U, R, or challenge N).

Fields

three_ds_server_trans_id: String

trans_status: TransStatus

reason_code: Option<String>

Failed

A protocol error was received; the transaction cannot continue.

Fields

error: String

Implementations

impl TransactionState

pub fn new(areq: AuthenticationRequest) -> Self

Create a new transaction from a constructed AReq.

pub fn areq_sent(self) -> Result<(Self, AuthenticationRequest)>

Mark the AReq as sent and transition to awaiting the ARes.

pub fn receive_ares(self, ares: AuthenticationResponse) -> Result<Self>

Process an incoming ARes and advance the state.

pub fn build_creq( &self, window_size: Option<ChallengeWindowSize>, ) -> Result<ChallengeRequest>

Build the CReq that should be submitted to the ACS challenge URL.

pub fn receive_cres(self, cres: ChallengeResponse) -> Result<Self>

Process an incoming CRes and advance to a terminal state.

pub fn receive_rreq(self, rreq: ResultsRequest) -> Result<Self>

Process an incoming RReq and advance to a terminal state. The caller must send ResultsResponse::acknowledge(&rreq) to the ACS.

pub fn receive_error(self, err: &ErrorMessage) -> Self

Handle a protocol error; always transitions to Failed.

pub fn is_terminal(&self) -> bool

Returns true if the transaction reached a terminal state.

Trait Implementations

impl Clone for TransactionState

fn clone(&self) -> TransactionState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransactionState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.