Skip to main content
POST
Create Session

Authorizations

Authorization
string
header
required

JWT token for merchant authentication

Path Parameters

storeId
string
required

The unique identifier of the store resource.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
campaign
string

Optional campaign keyword to filter payment methods. When provided, only payment methods matching this campaign keyword will be returned. When omitted, only non-campaign payment methods are returned.

Example:

"SUMMER_SALE"

Response

Session successfully created with token and expiration

id
string
required

Session ID for authenticating payment method requests. Use this ID for subsequent API calls.

Example:

"550e8400-e29b-41d4-a716-446655440000"

expiresAt
string<date-time>
required

Session expiration timestamp in ISO 8601 format. After this time, the session will no longer be valid for API requests.

Example:

"2025-11-17T15:30:00Z"

embed
object
required

Contains the script URL that merchants use to load payment method components in their storefront.