Sign in

Create a 3DS Authentication

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.

post/v1/three_d_secure/authentications

Response

Successful response.

amountinteger

The amount for this 3DS Authentication.

challenge_urlstring

The URL for presenting a challenge to your cardholder, present if status is requires_challenge.

createdinteger required

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

currencystring currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

directory_server'american_express' | 'cartes_bancaires' | 'discover' | 'mastercard' | 'visa' required

The 3DS directory server with which this 3DS Authentication was processed.

fingerprinting_urlstring

The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

message_category'non_payment_authentication' | 'payment_authentication' required

Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.

metadataobject nullable

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object'three_d_secure.authentication' required

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

outcome'abandoned' | 'attempt_acknowledged' | 'authenticated' | 'canceled' | 'denied' | 'informational' | 'internal_error' | 'not_supported' | 'not_triggered' | 'processing_error' | 'rejected'

The outcome of this 3DS Authentication.

reason'cardholder_authentication' | 'issuer_requested' | 'liability_shift' | 'processing_costs' | 'regulatory_compliance'

The reason for invoking this 3DS Authentication.

status'canceled' | 'error' | 'failed' | 'requires_challenge' | 'requires_submission' | 'succeeded' required

Status of this Authentication.

Changes

No changes found, but 18 of the 53 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.