Sign in

v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
v1
Session

Create a Checkout

Initiate a Sezzle session with shopper order details, redirect links, and capture settings

post/v1/checkouts

Request body

amount_in_centsstring required

The total order amount in cents, which must be at least 100 which is $1.00. Please note your merchant configuration might have a higher minimum.

currency_codestring required

The 3 character currency code as defined by ISO 4217

order_reference_idstring required

Your reference ID for this order (must contain only alphanumeric characters, dashes (-), and underscores (_))

order_descriptionstring required

A user-facing description for this checkout

checkout_cancel_urlstring required

The HTTP request information used to redirect the customer in the case of a cancellation

checkout_complete_urlstring required

The HTTP request information used to redirect the customer upon completion of the session

requires_shipping_infoboolean

Flag to indicate if you would like us to collect shipping information for this checkout from the customer. If omitted, defaults to false.

merchant_completesboolean

If your checkout flow requires the user to confirm their checkout on your site after being approved by Sezzle, use true to only authorize the payment. If you prefer the checkout be captured immediately, use false. Defaults to false.

locale'en-US' | 'en-CA' | 'fr-CA'

Localizes the checkout. Defaults to en-US.

Response

Successful operation

checkout_uuidstring

The unique identifier for this response

checkout_urlstring

The URL to which the shopper should be directed to complete their order with Sezzle