Create Session

Creates a new session that guides a customer through a payment flow. The session begins in CREATED state and transitions to ACTIVE once the customer opens the redirect URL. Redirect your customer to the returned session_url to begin the flow. Sessions expire after a fixed period if not completed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The identifier of the customer this session is created for. All activity within the session will be attributed to this customer.

flow
object
required

Defines the session flow type and its associated configuration payload.

uri
required

The URL your customer is redirected to after completing or cancelling the session flow. Must be an absolute URL. You can append query parameters to carry context (e.g., an order ID) back to your server when the customer returns.

Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json