Create a session for a payment service
Creates a session for a payment service. This endpoint directly passes the request through to the relevant payment service for processing, and so the schema will differ based on the service used.
If the downstream service returns an error, this API will return a successful response with the status code in the response.
This endpoint requires the transactions.write
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID of the payment service definition.
Body
A request to generate a session for a payment session.
Response
A session request for a payment session. This is an opaque object passed to the payment service.
The type of this resource.
payment-service-session
The status of the response.
succeeded
- The session was successfully generated.failed
- The session could not be generated.
succeeded
, failed
A generic error code that may be returned when the session could not be generated.
The HTTP status code received from the payment service.
The parsed JSON received from the payment service.
Was this page helpful?