Stripe: Three d secure schemas
17 Stripe schemas with complete fields and constraints.
← Three d secure operations · All schemas
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
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 — channel browser
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details on the browser for a standalone 3DS Authentication. |
accept_header | string | Required within parent | The HTTP accept headers from the cardholder's browser. Maximum length: 5000 |
color_depth | JSON | Optional | |
color_depth (anyOf 1) | integer | Alternative | The color depth of the cardholder’s screen. |
color_depth (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ip_address | string | Required within parent | The IP address of the browser. Maximum length: 5000 |
java_enabled | boolean | Optional | The cardholder browser’s ability to execute Java. |
javascript_enabled | boolean | Required within parent | The cardholder browser’s ability to execute JavaScript. |
language | string | Required within parent | An IETF BCP 47 language tag representing the browser language. Maximum length: 5000 |
screen_height | JSON | Optional | |
screen_height (anyOf 1) | integer | Alternative | The total height of the cardholder’s screen in pixels. |
screen_height (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
screen_width | JSON | Optional | |
screen_width (anyOf 1) | integer | Alternative | The total width of the cardholder’s screen in pixels. |
screen_width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone_offset | JSON | Optional | |
timezone_offset (anyOf 1) | integer | Alternative | The time difference between UTC time and the local time of the cardholder’s browser, in minutes. |
timezone_offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
user_agent | string | Required within parent | The browser user agent. Maximum length: 5000 |
Cancel a 3 DS Authentication — response body — channel three r i
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details for a 3RI standalone 3DS Authentication. |
previous_authentication | string | Required within parent | ID of the previous initial authenticated 3DS Authentication object. Maximum length: 5000 |
type | string | Required within parent | Type of the 3RI Authentication. Known values: delayed_shipment, other_payment, recurring, split_shipment |
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
Cancel a 3 DS Authentication — response body — flow preference challenge
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of challenge flow you requested for this 3DS Authentication. Known values: mandated, preferred |
Cancel a 3 DS Authentication — response body — flow preference data share
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of data share flow you requested for this 3DS Authentication. Known values: ds_specific, emv_standard |
Cancel a 3 DS Authentication — response body — flow preference frictionless
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of frictionless flow you requested for this 3DS Authentication. Known values: low_risk, none |
Cancel a 3 DS Authentication — response body — future usage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the future authorisations related to this authentication |
installment | Model | Optional | Expand Cancel a 3 DS Authentication — response body — future usage installment |
recurring | Model | Optional | Expand Cancel a 3 DS Authentication — response body — future usage recurring |
type | string | Required within parent | The 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
Cancel a 3 DS Authentication — response body — future usage installment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about installment payments |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expiry | Model | Required within parent | Expand Cancel a 3 DS Authentication — response body — future usage recurring expiry |
interval | string | Required within parent | The unit of time for `interval_count`. Known values: day |
interval_count | JSON | Required within parent | |
interval_count (anyOf 1) | integer | Alternative | The minimum number of time intervals between authorizations. |
interval_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | The maximum number of installments. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Cancel a 3 DS Authentication — response body — future usage recurring expiry
Cancel a 3 DS Authentication — response body — future usage recurring
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about recurring payments |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expiry | Model | Required within parent | Expand Cancel a 3 DS Authentication — response body — future usage recurring expiry |
interval | string | Required within parent | The unit of time for `interval_count`. Known values: day |
interval_count | JSON | Required within parent | |
interval_count (anyOf 1) | integer | Alternative | The minimum number of time intervals between authorizations. |
interval_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Cancel a 3 DS Authentication — response body — future usage recurring expiry
Cancel a 3 DS Authentication — response body — future usage recurring expiry
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about recurring payment expiry |
date | string | Optional | Maximum length: 5000 |
type | string | Required within parent | Known values: date, never |
Cancel a 3 DS Authentication — response body — outcome details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details on the result for a standalone 3DS Authentication. |
acs_transaction_id | string | Optional | Universally unique transaction identifier assigned by the issuer to identify the transaction. Maximum length: 5000 |
ares | string | Optional | The Authentication Response Message (ARes) is the issuer's response to the AReq message. Maximum length: 5000 |
ares_trans_status | string | Optional | TransStatus field on the ARes Known values: A, C, D, I, N, R, S, U, Y |
cryptogram | string | Optional | A 28-character Base64 string proving that 3DS was completed. Store this value securely, and don’t reuse it for multiple authorizations. Maximum length: 5000 |
ds_transaction_id | string | Optional | The 3DS2 Directory Server Transaction ID. Maximum length: 5000 |
eci | string | Optional | Electronic Commerce Indicator provided by the issuer to indicate the result of this 3DS Authentication. Maximum length: 5000 |
network_details | Model | Optional | Expand Cancel a 3 DS Authentication — response body — outcome details network details |
protocol_version | string | Required within parent | The 3DS protocol version used for this 3DS Authentication. Known values: 2.1.0, 2.2.0, 2.3.1 |
requestor_challenge_indicator | string | Optional | The indicator provided to the issuer by Stripe in the AReq that indicates whether a challenge is requested for this Authentication. This indicator should match the flow_preference you specified but may be overridden (for compliance reasons for example). Known values: 01, 02, 03, 04, 05, 06 |
rreq | string | Optional | The Results Request Message (RReq) communicates the results of the authentication or verification. Maximum length: 5000 |
rreq_trans_status | string | Optional | TransStatus field on the RReq Known values: A, C, D, I, N, R, S, U, Y |
three_ds_server_transaction_id | string | Required within parent | Universally unique transaction identifier assigned by Stripe to identify the transaction. Maximum length: 5000 |
Referenced models: Cancel a 3 DS Authentication — response body — outcome details network details
Cancel a 3 DS Authentication — response body — outcome details network details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details specific to the individual network. |
cartes_bancaires | Model | Optional | Expand Cancel a 3 DS Authentication — response body — outcome details network details cartes bancaires |
Referenced models: Cancel a 3 DS Authentication — response body — outcome details network details cartes bancaires
Cancel a 3 DS Authentication — response body — outcome details network details cartes bancaires
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details for Cartes Bancaires specific fields in the authentication outcomes. |
avalgo | string | Required within parent | The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. ARes/RReq messageExtension: `CB-AVALGO` Maximum length: 5000 |
cb_exemption | JSON | Optional | |
cb_exemption (anyOf 1) | string | Alternative | The exemption indicator returned from Cartes Bancaires in the ARes. This is a 3 byte bitmap (lowest significant byte first and most significant bit first) that has been Base64 encoded. String (4 characters). ARes message extension: `CB-EXEMPTION` Maximum length: 5000 |
cb_exemption (anyOf 2) | null | Alternative | |
cb_score | JSON | Optional | |
cb_score (anyOf 1) | string | Alternative | The risk score returned from Cartes Bancaires in the ARes. Numeric value 0-99. ARes/RReq message extension: `CB-SCORE` Maximum length: 5000 |
cb_score (anyOf 2) | null | Alternative |
Cancel a 3 DS Authentication — response body — shipping address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about the shipping address for a 3DS Authentication. |
city | string | Optional | City, district, suburb, town, or village. Maximum length: 5000 |
country | string | Optional | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000 |
line1 | string | Optional | Address line 1, such as the street, PO Box, or company name. Maximum length: 5000 |
line2 | string | Optional | Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000 |
postal_code | string | Optional | ZIP or postal code. Maximum length: 5000 |
state | string | Optional | State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000 |