Confirm checkout

Supports guest users.

Confirms a checkout by providing customer details and a payment return URL.
Returns a PSP payment URL to redirect the customer to. After payment the PSP
redirects back to return_url. Supports idempotency via the
Idempotency-Key header.

Events fired

EventTriggerDescription
checkouts.CheckoutFulfillmentRegisteredsyncFired when the checkout is confirmed and a fulfillment workflow has been registered.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required
string
required
string
required
string

Shipping street name. Required when the checkout contains a physical product; ignored otherwise.

string

Shipping house number. Required when the checkout contains a physical product; ignored otherwise.

string

Optional house-number addition (e.g. "A", "bis").

string

Shipping postal code. Required when the checkout contains a physical product; ignored otherwise.

string

Shipping city. Required when the checkout contains a physical product; ignored otherwise.

string

ISO 3166-1 alpha-2 country code of the shipping address (e.g. "NL"). Required when the checkout contains a physical product; ignored otherwise. Resolved to the order system's country on submit.

uri
required

URL the PSP redirects to after payment.

newsletters
array of strings

List of newsletter IDs the customer opted into.

newsletters
Headers
uuid
required

Campaign scope for this request. Filters content to the specified campaign.

uuid
required

Client-generated UUID. Identical keys within the TTL window return the cached response.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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