Retrieve the authentication session for a pending redirect action

GET

/intent-action-auth-session/{id}

Fetches the data required to render or complete a redirect-based authentication step for a payment intent action. This endpoint is called after a payment action has been dispatched and the provider has responded with a redirect (e.g. a 3DS challenge URL). It returns the amounts, fees, provider-specific redirect instructions, and the return URL to send the customer back to after they complete the authentication challenge.

The action must be in a pending status and its current step must be redirect. Attempting to fetch auth session data for an action in any other state (e.g. already successful, failed, or on a different step) will return a 400 error. This endpoint is typically called by the checkout front-end to hydrate the authentication page before redirecting the user.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

The intent action was found and is awaiting redirect authentication. Returns the amounts, fees, provider redirect instructions, and the URL to return the customer to after they complete the challenge.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/intent-action-auth-session/01J3K8VXZP4MNQR6TW9BCDEFGH' \
--header 'Authorization: Bearer <token>'

Response Example

200 - 3DS redirect for a card payment

{
    "message": "Intent action auth session retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J3K8VXZP4MNQR6TW9BCDEFGH",
        "amount": 150000,
        "charged_amount": 152250,
        "applicable_fee": 2250,
        "session_action": {
            "type": "redirect",
            "url": "https://3ds.provider.io/challenge?token=eyJhbGciOiJSUzI1NiJ9...",
            "context": {
                "is_3ds": true,
                "acs_transaction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
            }
        },
        "return_url": "https://checkout.example.com/payment/complete?ref=ord_abc123",
        "return_url_type": "redirect"
    }
}

Modified at 2026-08-06 20:27:00

Advance an intent action to the next step

Create a new account