Create a Checkout

POST

checkouts

Create a Checkout

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/checkouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_in_cents": 12999,
  "currency_code": "USD",
  "order_reference_id": "ord_12345",
  "order_description": "Some description",
  "checkout_cancel_url": "https://sezzle.com/cart",
  "checkout_complete_url": "https://sezzle.com/complete",
  "customer_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "8885401867"
  },
  "billing_address": {
    "name": "John Doe",
    "street": "123 W Lake St",
    "street2": "Unit 104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US",
    "phone_number": "8885401867"
  },
  "shipping_address": {
    "name": "John Doe",
    "street": "123 W Lake St",
    "street2": "Unit 104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US",
    "phone_number": "8885401867"
  },
  "requires_shipping_info": false,
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "discounts": [
    {
      "name": "20% off",
      "amount": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "tax_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "shipping_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "metadata": {
    "location_id": "123",
    "store_name": "Downtown Minneapolis",
    "store_manager": "Jane Doe"
  },
  "merchant_completes": true
}
'

{
  "checkout_uuid": "9dcb4d9f-ac09-4578-abf8-611128903611",
  "checkout_url": "https://sandbox.checkout.sezzle.com?id=9dcb4d9f-ac09-4578-abf8-611128903611"
}

You are viewing Version 1 of the Sezzle API. Check out the current version!

Authorizations

Authorization

string

header

required

The authentication token generated from providing API Keys to Sezzle Gateway

Body

application/json

amount_in_cents

string

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_code

string

required

The 3 character currency code as defined by ISO 4217

order_reference_id

string

required

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

order_description

string

required

A user-facing description for this checkout

checkout_cancel_url

string

required

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

checkout_complete_url

string

required

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

customer_details

object

Customer details for this session. To optimize checkout and boost conversion, it is recommended to include as much customer information as possible.

Hide child attributes

customer_details.first_name

string

The customer's first name

customer_details.last_name

string

The customer's last name

customer_details.email

string

The customer's email address

customer_details.phone

string

The customer's phone number

billing_address

object

The customer's billing address

Hide child attributes

billing_address.name

string | null

The name on the address

billing_address.street

string

The street and number of the address

billing_address.street2

string | null

The apt or unit

billing_address.city

string

The city

billing_address.state

string

The 2 character state code

billing_address.postal_code

string

The postal delivery code

billing_address.country_code

string

The 2 character country code

billing_address.phone_number

string | null

The phone number at the delivery location

shipping_address

object

The customer's shipping address

Hide child attributes

shipping_address.name

string | null

The name on the address

shipping_address.street

string

The street and number of the address

shipping_address.street2

string | null

The apt or unit

shipping_address.city

string

The city

shipping_address.state

string

The 2 character state code

shipping_address.postal_code

string

The postal delivery code

shipping_address.country_code

string

The 2 character country code

shipping_address.phone_number

string | null

The phone number at the delivery location

requires_shipping_info

boolean

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

items

object[]

The items being purchased

Hide child attributes

items.name

string

The name of the item

items.sku

string

The sku identifier

items.quantity

integer

The quantity purchased

items.price

object

The price of the product before tax and discounts

Hide child attributes

items.price.amount_in_cents

integer

required

The amount in cents

items.price.currency

string

required

The 3 character currency code as defined by ISO 4217

items.category_path

string

The category path where the product is located. Example: Camping Gear & Supplies > Tents & Shelters.

discounts

object[]

The discounts applied to this order. Must be included in total

Hide child attributes

discounts.name

string

The description of the discount

discounts.amount

object

A price object

Hide child attributes

discounts.amount.amount_in_cents

integer

required

The amount in cents

discounts.amount.currency

string

required

The 3 character currency code as defined by ISO 4217

tax_amount

object

The taxes applied to this order. Must be included in the total

Hide child attributes

tax_amount.amount_in_cents

integer

required

The amount in cents

tax_amount.currency

string

required

The 3 character currency code as defined by ISO 4217

shipping_amount

object

The shipping fees applied to this order. Must be included in the total

Hide child attributes

shipping_amount.amount_in_cents

integer

required

The amount in cents

shipping_amount.currency

string

required

The 3 character currency code as defined by ISO 4217

metadata

object

Object for any custom data you want to submit with the checkout. You are not limited to the key-value pairs shown in the example, and you may use any key-value pairs you like

Hide child attributes

metadata.any

string

Custom metadata field

merchant_completes

boolean

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.

send_checkout_url

object

A Notification object for sending checkout URL to the customer

Hide child attributes

send_checkout_url.to_sms_phone

string

The SMS phone number of the notification

send_checkout_url.to_email

string

The email address of the notification

send_checkout_url.language

enum<string>

The 2-character ISO 639 langauge code of the notification. Acceptable values are en and fr-CA. Will default to English if not provided.

Available options:

en,

fr-CA

locale

enum<string>

Localizes the checkout. Defaults to en-US.

Available options:

en-US,

en-CA,

fr-CA

Response

Successful operation

checkout_uuid

string

The unique identifier for this response

checkout_url

string

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

Orders

⌘I

Create a Checkout

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/checkouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_in_cents": 12999,
  "currency_code": "USD",
  "order_reference_id": "ord_12345",
  "order_description": "Some description",
  "checkout_cancel_url": "https://sezzle.com/cart",
  "checkout_complete_url": "https://sezzle.com/complete",
  "customer_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "8885401867"
  },
  "billing_address": {
    "name": "John Doe",
    "street": "123 W Lake St",
    "street2": "Unit 104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US",
    "phone_number": "8885401867"
  },
  "shipping_address": {
    "name": "John Doe",
    "street": "123 W Lake St",
    "street2": "Unit 104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US",
    "phone_number": "8885401867"
  },
  "requires_shipping_info": false,
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "discounts": [
    {
      "name": "20% off",
      "amount": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "tax_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "shipping_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "metadata": {
    "location_id": "123",
    "store_name": "Downtown Minneapolis",
    "store_manager": "Jane Doe"
  },
  "merchant_completes": true
}
'

{
  "checkout_uuid": "9dcb4d9f-ac09-4578-abf8-611128903611",
  "checkout_url": "https://sandbox.checkout.sezzle.com?id=9dcb4d9f-ac09-4578-abf8-611128903611"
}

API Reference

Tokenization

v1 (deprecated)

Create a Checkout

Authorizations

Body

Response