3DS Pass-Through

External authentication enables merchants to perform 3DS verification through a third-party provider and submit the result in the payment request.

This section describes how to structure the ThreeDS object and include authentication fields when using ThreeDSAuthMethod="EXTERNAL"..

ThreeDS Object

Request Parameters

Parameter	Type	Mandatory?	Description
`ThreeDSAuthMethod`	`string`	No	3D Secure authentication method used: `"EXTERNAL"` or `"DISABLED"`.
`ThreeDS`	`object`	Yes	3D Secure information when `ThreeDSAuthMethod="EXTERNAL"`.
`ThreeDS` → `Eci`	`string`	Yes	3D Secure ECI code.
`ThreeDS` → `Xid`	`string`	Yes	3D Secure transaction identifier.
`ThreeDS` → `Cavv`	`string`	Yes	Cardholder Authentication Verification Value (CAVV) in 3D Secure.
`ThreeDS` → `Version`	`string`	Yes	3D Secure protocol version.
`ThreeDS` → `TransactionId`	`string`	Yes	Transaction ID in 3D Secure.

Request Example

{
    "CardData": {
        "CardHolderName": "John Doe",
        "Pan": "4507990000004905",
        "CVV": "123",
        "Expiration": "08/30",
        "Email": "[email protected]",
        "Document": "74857601"
    },
    "Capture": true,
    "TargetCountryISO": "BR",
    "Currency": "BRL",
    "Amount": 25000,
    "Installments": 2,
    "Order": "CH2023-001",
    "Description": "Compra de teste",
    "Customer": {
        "FirstName": "João",
        "LastName": "Silva",
        "ReferenceCode": "JS-001",
        "PhoneNumber": "11987654321",
        "DocumentNumber": "12345678901",
        "DocumentType": "CPF.BR",
        "Email": "[email protected]",
        "Address": {
            "Country": "BR",
            "City": "São Paulo",
            "State": "SP",
            "PostalCode": "01310-200",
            "AddressDetail": "Avenida Paulista 1000"
        }
    },
    "ThreeDSAuthMethod": "EXTERNAL",
    "ThreeDS": {
        "Eci": "05",
        "Xid": "MDAwMDAwMDAwMDAwMDAwMDAwMDE=",
        "Cavv": "kBNcxqbmcXUxhAE1yKRHAAAAAAA=",
        "Version": "2.2.0",
        "TransactionId": "97267598-FAE6-48F2-8083-C23433990FBC"
    }
}

The response follows the standard response format. See Create a Purchase for details.