Skip to content

Stripe: List all 3 D Secure Authentications

Stripe threeDSecure.getThreeDsecureAuthentications: arguments, response, policy and SDK examples.

← Three d secure operations · Get started

Operation stripe.getthreedsecureauthentications

Provider route: GET /v1/three_d_secure/authentications. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["threeDSecure"]["getThreeDsecureAuthentications"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.threeDSecure.getThreeDsecureAuthentications(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.three_d_secure.get_three_dsecure_authentications(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.createdJSONOptional
query.created (anyOf 1)objectAlternative
query.created (anyOf 1).gtintegerOptional
query.created (anyOf 1).gteintegerOptional
query.created (anyOf 1).ltintegerOptional
query.created (anyOf 1).lteintegerOptional
query.created (anyOf 2)integerAlternative
query.ending_beforestringOptionalMaximum length: 5000
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000
query.limitintegerOptional
query.starting_afterstringOptionalMaximum length: 5000
query.statusstringOptionalOne of: canceled, error, failed, requires_challenge, requires_submission, succeeded

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Cancel a 3 DS Authentication — response body
has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
objectstringRequired within parentString representing the object’s type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
Pattern: ^/v1/three_d_secure/authentications

Referenced models: Cancel a 3 DS Authentication — response body

720 more schemas are linked from the tables above, on the schema pages.

Cancel a 3 DS Authentication — response body
FieldTypePresenceDescription and constraints
$objectRootThe Standalone 3DS API allows you to run EMV 3D Secure (3DS) authentication using Stripe while authorizing the payment with any PSP.

Related guide: [Standalone 3DS](/payments/3d-secure/standalone-3d-secure)
acquirer_detailsModelOptionalExpand Cancel a 3 DS Authentication — response body — acquirer details
amountJSONOptional
amount (anyOf 1)integerAlternativeThe amount for this 3DS Authentication.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
challenge_urlstringOptionalThe URL for presenting a challenge to your cardholder, present if status is requires_challenge.
Maximum length: 5000
channelModelRequired within parentExpand Cancel a 3 DS Authentication — response body — channel
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringOptionalThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
Format: currency
directory_serverstringRequired within parentThe 3DS directory server with which this 3DS Authentication was processed.
Known values: american_express, cartes_bancaires, discover, mastercard, visa
fingerprinting_urlstringOptionalThe URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.
Maximum length: 5000
flow_preferenceModelOptionalExpand Cancel a 3 DS Authentication — response body — flow preference
future_usageModelOptionalExpand Cancel a 3 DS Authentication — response body — future usage
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
message_categorystringRequired within parentIndicates whether this 3DS Authentication is being performed for a payment or non-payment use case.
Known values: non_payment_authentication, payment_authentication
metadataJSONOptional
metadata (anyOf 1)objectAlternativeSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keysMaximum length: 500
metadata (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: three_d_secure.authentication
outcomestringOptionalThe outcome of this 3DS Authentication.
Known values: abandoned, attempt_acknowledged, authenticated, canceled, denied, informational, internal_error, not_supported, not_triggered, processing_error, rejected
outcome_detailsModelOptionalExpand Cancel a 3 DS Authentication — response body — outcome details
payment_methodJSONRequired within parentID of the payment method (a PaymentMethod object) to attach to this 3DS Authentication.
payment_method (anyOf 1)stringAlternativeMaximum length: 5000
payment_method (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
reasonstringOptionalThe reason for invoking this 3DS Authentication.
Known values: cardholder_authentication, issuer_requested, liability_shift, processing_costs, regulatory_compliance
shipping_addressModelOptionalExpand Cancel a 3 DS Authentication — response body — shipping address
statusstringRequired within parentStatus of this Authentication.
Known values: canceled, error, failed, requires_challenge, requires_submission, succeeded

Referenced models: Create a Payment Method — response body, Cancel a 3 DS Authentication — response body — acquirer details, Cancel a 3 DS Authentication — response body — channel, Cancel a 3 DS Authentication — response body — flow preference, Cancel a 3 DS Authentication — response body — future usage, Cancel a 3 DS Authentication — response body — outcome details, Cancel a 3 DS Authentication — response body — shipping address

Cancel a 3 DS Authentication — response body — acquirer details
FieldTypePresenceDescription and constraints
$objectRootContains additional details about the acquirer for a 3DS Authentication.
acquirer_binstringOptionalThe Acquirer BIN (specific to the directory_server).
Maximum length: 5000
acquirer_countrystringOptionalThe two-letter country code of the acquirer ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
acquirer_merchant_idstringOptionalThe Merchant ID (or Card Acceptor ID) that your acquirer assigned you (specific to the directory_server).
Maximum length: 5000
mccstringOptionalThe [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) as defined by each payment system or directory server.
Maximum length: 5000
merchant_namestringOptionalThe merchant name assigned by the acquirer or payment system. Same name used in the authorization message as defined in [ISO 8583](https://en.wikipedia.org/wiki/ISO_8583).
Maximum length: 5000
requestor_idstringOptionalRequestor ID if you’re enrolled in the card network’s 3DS program. Otherwise, you can omit this field because Stripe assigns a Requestor ID with the card networks.
Maximum length: 5000
Cancel a 3 DS Authentication — response body — channel
FieldTypePresenceDescription and constraints
$objectRootContains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.
browserModelOptionalExpand Cancel a 3 DS Authentication — response body — channel browser
three_r_iModelOptionalExpand Cancel a 3 DS Authentication — response body — channel three r i
typestringRequired within parentType of channel you would prefer to use for this 3DS Authentication. Only browser.
Known values: browser, three_r_i

Referenced models: Cancel a 3 DS Authentication — response body — channel browser, Cancel a 3 DS Authentication — response body — channel three r i

Cancel a 3 DS Authentication — response body — flow preference
FieldTypePresenceDescription and constraints
$objectRootContains details of the flow preference used for a standalone 3DS Authentication.
challengeModelOptionalExpand Cancel a 3 DS Authentication — response body — flow preference challenge
data_shareModelOptionalExpand Cancel a 3 DS Authentication — response body — flow preference data share
frictionlessModelOptionalExpand Cancel a 3 DS Authentication — response body — flow preference frictionless
typestringRequired within parentType of flow you requested for this 3DS Authentication.
Known values: challenge, data_share, frictionless

Referenced models: Cancel a 3 DS Authentication — response body — flow preference challenge, Cancel a 3 DS Authentication — response body — flow preference data share, Cancel a 3 DS Authentication — response body — flow preference frictionless

Cancel a 3 DS Authentication — response body — future usage
FieldTypePresenceDescription and constraints
$objectRootContains information about the future authorisations related to this authentication
installmentModelOptionalExpand Cancel a 3 DS Authentication — response body — future usage installment
recurringModelOptionalExpand Cancel a 3 DS Authentication — response body — future usage recurring
typestringRequired within parentThe type of future usage declared for this 3DS Authentication.
Known values: card_on_file, installment, recurring

Referenced models: Cancel a 3 DS Authentication — response body — future usage installment, Cancel a 3 DS Authentication — response body — future usage recurring

Create a Payment Method — response body — zip
FieldTypePresenceDescription and constraints
$objectRoot

SDK function policy ID: stripe.getthreedsecureauthentications. Catalog operation: GetThreeDSecureAuthentications. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.