post

/merchant/{sessmerchantId}/session

Create Hosted Checkout Session allows you to create a session that includes a session identifier for the checkout interaction.

The identifier will be included in the Checkout.configure() function. It allows you to return the payer to the merchant’s website after completing the payment attempt.

Create Hosted Checkout Session is recommended in cases where you’ll be creating a new Session each time your customer attempts to pay (one-time purchases or subscriptions are often processed through Checkout).

The request model for this call is Create Checkout Session (apiOperation = “CREATE_CHECKOUT_SESSION”). Objects like agreement, authentication, customer, order and interaction (each with nested fields) are included.

Request Parameters

1 Path Parameter
1 Header

Request Body

1 Example
Schema
object
apiOperation
string
2 validations + required
correlationId
string
lineOfBusiness
string
partnerSolutionId
string
userId
string
action
object
agreement
object
authentication
object
billing
object
constraints
object
customer
object
debtRepayment
object
device
object
externalTokenProvider
object
interaction
object
order
object
risk
object
shipping
object
transaction
object

Responses

Schema
object
correlationId
string
lineOfBusiness
string
merchant
string
required
result
string
required
session
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
sessmerchantId
$$.env
payAuthHeader
merchantId