POST
/
payment-service-definitions
/
{payment_service_definition_id}
/
sessions

This endpoint requires the transactions.write scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_service_definition_id
string
required

The unique ID of the payment service definition.

Body

application/json · object

A request to generate a session for a payment session.

Response

200 - application/json

A session request for a payment session. This is an opaque object passed to the payment service.

type
enum<string>

The type of this resource.

Available options:
payment-service-session
status
enum<string>

The status of the response.

  • succeeded - The session was successfully generated.
  • failed - The session could not be generated.
Available options:
succeeded,
failed
code
string | null

A generic error code that may be returned when the session could not be generated.

status_code
number | null

The HTTP status code received from the payment service.

response_body
object | null

The parsed JSON received from the payment service.