Skip to main content

createSessionToken Method

Overview

The createSessionToken method creates a session token for payment processing. This token maintains state across multiple payment operations, enabling secure tracking for multi-step payment flows.

Business Use Case: When processing payments that require multiple steps (3DS authentication, redirect flows), you need to maintain session state between requests.

Purpose

ScenarioBenefit
3DS authenticationMaintain context through challenge flow
Redirect paymentsPreserve state during bank redirects
Multi-step checkoutTrack progress across pages

Request Fields

FieldTypeRequiredDescription
merchantSessionIdstringYesYour unique session reference
amountMoneyYesPayment amount for this session
metadataobjectNoAdditional metadata
testModebooleanNoUse test environment

Response Fields

FieldTypeDescription
sessionTokenstringToken for subsequent operations
statusCodenumberHTTP status code

Example

SDK Setup

const { MerchantAuthenticationClient } = require('hyperswitch-prism');

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

Request

const request = {
merchantSessionId: "session_001",
amount: {
minorAmount: 10000,
currency: "USD"
},
testMode: true
};

const response = await authClient.createSessionToken(request);

Response

{
sessionToken: "sess_1234567890abcdef",
statusCode: 200
}

Next Steps