v1 (deprecated)

Complete a Checkout

Initiate order payment capture if merchant_completes was true at Create Checkout. An example use-case is if users need to return to the merchant’s site before finalizing the purchase with Sezzle. Submit the Complete Checkout request within 30 minutes after the user is redirected to the merchant’s site. Failure to do so results in Sezzle canceling the checkout. The default expiration period for new orders can be extended up to 7 days via the Merchant Dashboard.

POST

checkouts

{order_reference_id}

complete

Complete a Checkout

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/checkouts/{order_reference_id}/complete \
  --header 'Authorization: <api-key>'

{
  "amount_in_cents": 12999,
  "currency_code": "USD",
  "order_description": "Order #1800",
  "order_reference_id": "ord_12345",
  "display_order_reference_id": "ord_12345",
  "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 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "shipping_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "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"
  },
  "merchant_completes": true
}

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

Path Parameters

order_reference_id

string

required

The Order Reference ID to update

Response

Successful Operation

amount_in_cents

number

The order total amount in cents

currency_code

string

The 3 character currency code as defined by ISO 4217

order_description

string

Your description for this order

order_reference_id

string

The checkout or cart ID from the merchant, currently used for tracking only (must contain only alphanumeric characters, dashes (-), and underscores (_))

display_order_reference_id

string

checkout_cancel_url

string

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

checkout_complete_url

string

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

customer

object

The customer's basic contact information

Hide child attributes

customer.first_name

string

The customer's first name

customer.last_name

string

The customer's last name

customer.email

string

The customer's email address

customer.phone

string

The customer's phone number

billing_address

object

The customer's billing address

Hide child attributes

billing_address.name

string

The name on the address

billing_address.street

string

The street and number of the address

billing_address.street2

string

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

The phone number at the delivery location

shipping_address

object

The customer's shipping address

Hide child attributes

shipping_address.name

string

The name on the address

shipping_address.street

string

The street and number of the address

shipping_address.street2

string

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

The phone number at the delivery location

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

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.

Refund RequestRefund an amount by order, either partial or in full. An example use-case is when an order was captured but the customer returned item(s) that requires them to be refunded.

⌘I

Complete a Checkout

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/checkouts/{order_reference_id}/complete \
  --header 'Authorization: <api-key>'

{
  "amount_in_cents": 12999,
  "currency_code": "USD",
  "order_description": "Order #1800",
  "order_reference_id": "ord_12345",
  "display_order_reference_id": "ord_12345",
  "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 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "shipping_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "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"
  },
  "merchant_completes": true
}

API Reference

Tokenization

v1 (deprecated)

Complete a Checkout

Authorizations

Path Parameters

Response