Skip to content

Retrieve an authentication

GET
/payments/card/authentications/{id}

Reading settles a lapsed TTL first, so an authentication the shopper abandoned reports expired rather than looking usable because nothing swept it.

id
required

Our identifier for an authentication.

string
Example
ca_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Authentication ID

The authentication

An authentication, as the merchant sees it.

Built by hand rather than derived on [CardAuthentication], for the same reason CheckoutSessionResponse is: the domain type holds things that must not be echoed. consumed_by, the processor’s own handle, and the merchant id are all deliberately absent — the merchant references the ca_ id, and nothing here needs the upstream one.

object
amount
required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64
Example
1000
challenge
One of:
null
created
required
integer format: int64
currency
required

Currently supported currencies by Paygasus Pay

string
Allowed values: USD
Example
USD
expires_at
required

When this authentication stops being usable, in every state — including authenticated: a verdict that has not been charged by this time expires and cannot be referenced. Once a charge has used it the field is informational.

integer format: int64
failure_reason

Why it failed, when it did.

string | null
fingerprint
One of:
null
id
required

Our identifier for an authentication.

string
Example
ca_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV
livemode
required
boolean
object
required
string
status
required

The lifecycle of one 3DS run.

A plain enum with the state-specific data on [CardAuthentication] rather than in the variants, matching [crate::checkout_session::CheckoutSessionStatus] and unlike [crate::payment_intent::CardPaymentIntentStatus]. The reason is the repository: status is one column and the outcome fields are their own columns, so [std::str::FromStr] has to round-trip from the string alone.

string
Allowed values: created fingerprint_collected challenge_pending authenticated failed expired abandoned

No such authentication

object
error
required
object
code
required
string
message
required
string
param
string | null
retryable

When present and true, the caller may retry the same request.

boolean | null
type
required
string