Skip to main content
Manja / Stripe
Schema2020-08-27object

three_d_secure

Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` object. Once the object has been created, you can use it to authenticate the cardholder and create a charge.

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

ThreeDSecure

object

Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` object. Once the object has been created, you can use it to authenticate the cardholder and create a charge.

amount integer
required

Amount of the charge that you will create when authentication completes.

authenticated boolean
required

True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.

card Card object
required

You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string
required

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).

maxLength:5000

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "three_d_secure"

redirect_url string
optionalnullable

If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".

maxLength:5000

status string
required

Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully.

maxLength:5000