Skip to main content

createAccessToken Method

Overview

The createAccessToken method generates a short-lived authentication token for accessing payment processor APIs. Use this for temporary, secure access without exposing long-lived credentials.

Business Use Case: Your frontend needs to initialize a payment widget. Generate a temporary token with limited scope and short expiry for client-side use.

Purpose

ScenarioBenefit
Frontend SDKsSecure client-side initialization
Delegated accessScoped tokens for third parties
Session-based authTime-limited access

Request Fields

FieldTypeRequiredDescription
scopestringNoToken scope (e.g., "payment:write")
expiresInnumberNoToken lifetime in seconds (default: 3600)

Response Fields

FieldTypeDescription
accessTokenstringThe token string to use in API calls
tokenTypestringBearer
expiresInnumberSeconds until expiry
expiresAtstringISO 8601 expiry timestamp
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 = {
scope: "payment:write",
expiresIn: 3600
};

const response = await authClient.createAccessToken(request);

Response

{
accessToken: "sk_test_xxx",
tokenType: "Bearer",
expiresIn: 3600,
expiresAt: "2024-01-15T11:30:00Z",
statusCode: 200
}

Security Best Practices

  • Use short expiry times (1 hour or less)
  • Transmit only over HTTPS
  • Never store tokens client-side long-term
  • Implement token refresh logic

Next Steps