> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/prism/node/payment-method-authentication-service/pre-authenticate.md).

# Pre-authenticate

## Overview

The `preAuthenticate` method initiates the 3D Secure authentication flow. It collects device data and prepares the authentication context, determining whether frictionless or challenge-based verification is needed.

**Business Use Case:** Before processing a high-value transaction, initiate 3DS to reduce fraud liability and comply with Strong Customer Authentication (SCA) requirements.

## Purpose

| Scenario         | Benefit                                     |
| ---------------- | ------------------------------------------- |
| Fraud prevention | Shift liability to card issuer              |
| SCA compliance   | Meet European regulatory requirements       |
| Risk-based auth  | Frictionless flow for low-risk transactions |

## Request Fields

| Field             | Type          | Required | Description                 |
| ----------------- | ------------- | -------- | --------------------------- |
| `merchantOrderId` | string        | Yes      | Your unique order reference |
| `amount`          | Money         | Yes      | Transaction amount          |
| `paymentMethod`   | PaymentMethod | Yes      | Card details                |
| `customer`        | Customer      | No       | Customer information        |
| `returnUrl`       | string        | Yes      | URL to redirect after 3DS   |

## Response Fields

| Field                    | Type   | Description                            |
| ------------------------ | ------ | -------------------------------------- |
| `connectorTransactionId` | string | Connector's 3DS transaction ID         |
| `status`                 | string | AUTHENTICATION\_REQUIRED, FRICTIONLESS |
| `authenticationData`     | object | Device data for next step              |
| `redirectionData`        | object | Challenge URL if required              |
| `statusCode`             | number | HTTP status code                       |

## Example

### SDK Setup

```javascript
const { PaymentMethodAuthenticationClient } = require('hyperswitch-prism');

const authClient = new PaymentMethodAuthenticationClient({
    connector: 'stripe',
    apiKey: 'YOUR_API_KEY',
    environment: 'SANDBOX'
});
```

### Request

```javascript
const request = {
    merchantOrderId: "order_001",
    amount: {
        minorAmount: 10000,
        currency: "USD"
    },
    paymentMethod: {
        card: {
            cardNumber: { value: "4242424242424242" },
            cardExpMonth: { value: "12" },
            cardExpYear: { value: "2027" }
        }
    },
    returnUrl: "https://your-app.com/3ds/return"
};

const response = await authClient.preAuthenticate(request);
```

### Response - Frictionless

```javascript
{
    connectorTransactionId: "pi_3Oxxx...",
    status: "FRICTIONLESS",
    authenticationData: {
        eci: "05",
        cavv: "AAABBIIFmA=="
    },
    statusCode: 200
}
```

### Response - Challenge Required

```javascript
{
    connectorTransactionId: "pi_3Oxxx...",
    status: "AUTHENTICATION_REQUIRED",
    redirectionData: {
        url: "https://acs.bank.com/3ds/challenge",
        method: "POST"
    },
    statusCode: 200
}
```

## 3DS Flow

```mermaid
sequenceDiagram
    participant App as Your App
    participant CS as Prism
    participant Bank as Issuer Bank

    App->>CS: preAuthenticate
    CS->>Bank: Check 3DS eligibility
    Bank-->>CS: Return: frictionless or challenge
    CS-->>App: Return authentication data
    alt Challenge Required
        App->>Bank: Redirect customer to challenge
        Bank-->>App: Customer completes challenge
    end
    App->>CS: authenticate
    CS-->>App: Final authentication result
```

## Next Steps

* [authenticate](/integrations/prism/node/payment-method-authentication-service/authenticate.md) - Complete the 3DS flow
* [authorize](/integrations/prism/node/payment-service/authorize.md) - Process payment with 3DS data


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integrations/prism/node/payment-method-authentication-service/pre-authenticate.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.