API reference

Create Checkout Session

post
https://api.mollie.com/v2/sessions
🚧

Beta feature

This feature is currently in beta.

The shipping and requiredCustomerDetails properties are still in private beta.

Create a Checkout Session to start a checkout process with Mollie Components.

🔑

Access with

API keyAdvanced access token with sessions.writeOAuth access with sessions.write
Body Params
amount
object
required

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

string
required

A user-friendly description of the Checkout Session that may be shown to the customer during the checkout process.

Any payment created for the Checkout Session will use the same description.

lines
array of objects
required

List of items the customer will pay for in this Checkout Session. The sum of all line items must equal the Checkout Session's amount.

All lines must have the same currency as the Checkout Session.

lines*
string
required

The URL your customer will be redirected to after the payment process.

It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the right page referencing the order when your customer returns.

requiredCustomerDetails
array of strings, unique
🚧

Private beta

This property is currently in private beta, and the final specification may still change.

Declare which customer details should be collected during checkout. Mollie can collect these details for you with the Express Component and returns them on the Checkout Session's and payment's billingAddress and shippingAddress.

Show Details
emailThe customer's email address.
billing-addressThe customer's full billing address, including their name.
shipping-addressThe customer's full shipping address, including their name.
requiredCustomerDetails
billingAddress
object

The customer's billing address details. We advise to provide these details to improve fraud protection and conversion.

shippingAddress
object

The customer's shipping address details. We advise to provide these details to improve fraud protection and conversion.

shipping
🚧

Private beta

This property is currently in private beta, and the final specification may still change.

Shipping information for the Checkout Session. Provide either options or callbackUrl, not both.

The lines of the Checkout Session must not contain a line with type shipping_fee. When shipping is set, requiredCustomerDetails must contain shipping-address.

string | null
^cst_.+$

The ID of the customer the Checkout Session is being created for. This is used primarily for recurring payments, but can also be used on regular payments to enable single-click payments.

If sequenceType is set to first, this field is required.

string

Only relevant for recurring payments.

Indicate if this Checkout Session is used for a one-off or a first of a recurring payment.

With a first payment, the customer agrees to automatic recurring charges taking place on their account in the future.

Defaults to oneoff, which is a regular non-recurring payment.

Possible values: oneoff first

metadata
object

Provide any data you like in a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

Any payment created for the Checkout Session will use the same metadata.

payment
object
string
^pfl_.+$

The identifier referring to the profile this entity belongs to.

When using an API Key, the profileId must not be sent since it is linked to the key. However, for OAuth and Organization tokens, the profileId is required.

For more information, see Authentication.

boolean | null

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated 7 months ago

Did this page help you?