Stripe: Cancel a 3 DS Authentication

← Three d secure operations · Get started

Operation stripe.postthreedsecureauthenticationsauthenticationcancel

Provider route: POST /v1/three_d_secure/authentications/{authentication}/cancel. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["postThreeDsecureAuthenticationsAuthenticationCancel"]>[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.postThreeDsecureAuthenticationsAuthenticationCancel(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.post_three_dsecure_authentications_authentication_cancel(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.authentication	string	Required within parent	Maximum length: 5000
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	Model	Optional	Expand Update a payout — request body — body

Referenced models: Update a payout — request body — body

Response

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

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Cancel a 3 DS Authentication — response body

Referenced models: Cancel a 3 DS Authentication — response body

Schemas

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

Cancel a 3 DS Authentication — response body

Field	Type	Presence	Description and constraints
$	object	Root	The 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_details	Model	Optional	Expand Cancel a 3 DS Authentication — response body — acquirer details
amount	JSON	Optional
amount (anyOf 1)	integer	Alternative	The amount for this 3DS Authentication.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
challenge_url	string	Optional	The URL for presenting a challenge to your cardholder, present if status is requires_challenge. Maximum length: 5000
channel	Model	Required within parent	Expand Cancel a 3 DS Authentication — response body — channel
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Optional	Three-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_server	string	Required within parent	The 3DS directory server with which this 3DS Authentication was processed. Known values: american_express, cartes_bancaires, discover, mastercard, visa
fingerprinting_url	string	Optional	The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method. Maximum length: 5000
flow_preference	Model	Optional	Expand Cancel a 3 DS Authentication — response body — flow preference
future_usage	Model	Optional	Expand Cancel a 3 DS Authentication — response body — future usage
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
message_category	string	Required within parent	Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case. Known values: non_payment_authentication, payment_authentication
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set 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).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: three_d_secure.authentication
outcome	string	Optional	The outcome of this 3DS Authentication. Known values: abandoned, attempt_acknowledged, authenticated, canceled, denied, informational, internal_error, not_supported, not_triggered, processing_error, rejected
outcome_details	Model	Optional	Expand Cancel a 3 DS Authentication — response body — outcome details
payment_method	JSON	Required within parent	ID of the payment method (a PaymentMethod object) to attach to this 3DS Authentication.
payment_method (anyOf 1)	string	Alternative	Maximum length: 5000
payment_method (anyOf 2)	Model	Alternative	Expand Create a Payment Method — response body
reason	string	Optional	The reason for invoking this 3DS Authentication. Known values: cardholder_authentication, issuer_requested, liability_shift, processing_costs, regulatory_compliance
shipping_address	Model	Optional	Expand Cancel a 3 DS Authentication — response body — shipping address
status	string	Required within parent	Status 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

Update a payout — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
expand	array	Optional	Specifies which fields in the response should be expanded.
expand[]	string	Each item	Maximum length: 5000
metadata	JSON	Optional	Set 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
metadata (anyOf 1)	object	Alternative	Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys
metadata (anyOf 2)	string	Alternative	One of:

Cancel a 3 DS Authentication — response body — acquirer details

Field	Type	Presence	Description and constraints
$	object	Root	Contains additional details about the acquirer for a 3DS Authentication.
acquirer_bin	string	Optional	The Acquirer BIN (specific to the directory_server). Maximum length: 5000
acquirer_country	string	Optional	The 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_id	string	Optional	The Merchant ID (or Card Acceptor ID) that your acquirer assigned you (specific to the directory_server). Maximum length: 5000
mcc	string	Optional	The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) as defined by each payment system or directory server. Maximum length: 5000
merchant_name	string	Optional	The 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_id	string	Optional	Requestor 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

Field	Type	Presence	Description and constraints
$	object	Root	Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.
browser	Model	Optional	Expand Cancel a 3 DS Authentication — response body — channel browser
three_r_i	Model	Optional	Expand Cancel a 3 DS Authentication — response body — channel three r i
type	string	Required within parent	Type 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

Field	Type	Presence	Description and constraints
$	object	Root	Contains details of the flow preference used for a standalone 3DS Authentication.
challenge	Model	Optional	Expand Cancel a 3 DS Authentication — response body — flow preference challenge
data_share	Model	Optional	Expand Cancel a 3 DS Authentication — response body — flow preference data share
frictionless	Model	Optional	Expand Cancel a 3 DS Authentication — response body — flow preference frictionless
type	string	Required within parent	Type 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

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Create a Payment Method — response body — boleto

Field	Type	Presence	Description and constraints
$	object	Root
tax_id	string	Required within parent	Uniquely identifies the customer tax id (CNPJ or CPF) Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.postthreedsecureauthenticationsauthenticationcancel. Catalog operation: PostThreeDSecureAuthenticationsAuthenticationCancel. 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