Introduction

The Sezzle API v2 is intended for merchants interested in accepting Sezzle as a payment option while using the latest features offered by v2.

Sezzle supports individually authorized transactions for a single purchase of goods or services, and v2 also supports tokenization of a customer for future transactions.

In addition to a direct API integration, Sezzle also offers integrations with some of the most popular eCommerce platforms.

Please choose your platform to see the relevant documentation:
Note that ^v1 indicates support for v1 API only.
1. 3DCart ^v1
2. BigCommerce
3. Bold Cashier ^v1
4. BuyItLive ^v1
5. CommentSold ^v1
6. Lightspeed
7. Magento 1 ^v1
8. Magento 2
9. Mojo
10. NopCommerce ^v1
11. PrestaShop
12. Salesforce Commerce Cloud
13. Shopify ^v1
14. Shopware 5
15. Wix
16. WooCommerce ^v1
17. Zoey ^v1

Field or header names in bold case followed by an asterisk are required. For example, this_is_required* is a required field whereas this_is_optional is not.

If you have any questions regarding our API, please reach out to our team by email at dev@sezzle.com.

Integration Flow

Order payment flow

1. Merchant calls /v2/session with order and intent of AUTH or CAPTURE. Optionally, the merchant can send customer information.
2. Sezzle returns order uuid and checkout URL.
3. Merchant redirects customer to Sezzle checkout URL.
4. Customer completes the Sezzle checkout and is redirected to the session complete URL.
   • If the intent was to CAPTURE, Sezzle will capture the total order amount.
   • If the intent was to AUTH, Sezzle will only authorize the total order amount and the merchant can call /v2/order later to release or capture amounts using the order uuid.

Customer tokenization

1. Merchant calls /v2/session with customer tokenize of true. Optionally, the merchant can send customer information.
2. Sezzle returns the tokenize session token and approval URL.
3. Merchant redirects customer to Sezzle approval URL.
4. Customer can agree (or disagree) to allow future Sezzle transactions by the merchant and is redirected to the session complete URL. If the customer agrees to be tokenized, Sezzle will add a query parameter to the complete URL named customer-uuid, allowing the merchant to get the uuid of the customer.
   • Alternatively, the merchant can call /v2/token with this tokenize session token to get the uuid of the customer.
5. Merchant can subsequently charge the customer by calling /v2/customer to create an order using the customer-uuid.
   • If successful, merchant can call /v2/order to release, capture, or refund the order.

Authentication

Obtain Authentication Token

To authorize, use the following format:

Request Body

{
    "public_key": "myPublicKey",
    "private_key": "myPrivateKey"
}

Make sure to replace keys with your API keys from your Merchant Dashboard.

Response Body

{
    "token": "authToken",
    "expiration_date": "2017-01-01T01:30:25.388940303Z",
    "merchant_uuid": "merchant1234567890"
}

POST https://gateway.sezzle.com/v2/authentication

Sezzle uses scoped API keys to allow access to the API. You can find/generate these keys on your merchant dashboard once you have been approved by Sezzle.

Once you have a valid token, it must be used as a Header for subsequent requests to our API, using the format below.

Authorization: Bearer authToken

Sessions

A session represents an order, a tokenization of a customer, or both. Use the session endpoints to post a new session or get the details of an existing session.

Create a session

Request Body

{
  "cancel_url": {
    "href": "https://sezzle.com/cart",
    "method": "GET"
  },
  "complete_url": {
    "href": "https://sezzle.com/complete",
    "method": "GET"
  },
  "customer": {
    "tokenize": true,
    "email": "john.doe@sezzle.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "5555045294",
    "dob": "1990-02-25",
    "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": "5555045294"
    },
    "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": "5555045294"
    }
  },
  "order": {
    "intent": "CAPTURE",
    "reference_id": "ord_12345",
    "description": "sezzle-store - #12749253509255",
    "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"
          }
        }
    ],
    "metadata": {
      "location_id": "123",
      "store_name": "Downtown Minneapolis",
      "store_manager": "Jane Doe"
    },
    "shipping_amount": {
      "amount_in_cents": 1000,
      "currency": "USD"
    },
    "tax_amount": {
      "amount_in_cents": 1000,
      "currency": "USD"
    },
    "order_amount": {
      "amount_in_cents": 10000,
      "currency": "USD"
    }
  }
}

Response Body

{
  "uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9",
      "method": "GET",
      "rel": "self"
    }
  ],
  "order": {
    "uuid": "12a34bc5-6de7-890f-g123-4hi1238jk902",
    "checkout_url": "https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902",
    "intent": "CAPTURE",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
        "method": "GET",
        "rel": "self"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
        "method": "PATCH",
        "rel": "self"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release",
        "method": "POST",
        "rel": "release"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture",
        "method": "POST",
        "rel": "capture"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund",
        "method": "POST",
        "rel": "refund"
      }
    ]
  },
  "tokenize": {
    "token": "7ec98824-67cc-469c-86ab-f9e047f9cf1a",
    "expiration": "2020-04-27T14:46:59Z",
    "approval_url": "https://dashboard.sezzle.com/customer/checkout-approval?merchant-request-id=3f3244fd-78ce-4994-af0c-b8c760d47794",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/token/7ec98824-67cc-469c-86ab-f9e047f9cf1a/session",
        "method": "GET",
        "rel": "token"
      }
    ]
  }
}

POST https://gateway.sezzle.com/v2/session

This endpoint creates a session in our system, and it returns the URL that you should redirect the user to. You can use a session to create an order, tokenize a customer, or both.

We suggest you provide as much optional information about the user as you have available, since this will speed up our checkout process and increase conversion.

If you submit an order with a session, then Sezzle is able to handle the entire checkout process after an order has been provided. However, if your flow requires that the user confirm their checkout on your site after being approved by Sezzle, you may set the intent parameter to AUTH with the session request. In this flow, Sezzle will not complete the transaction unless you make a capture request. Capture requests can be made to capture all or part of the original order amount. You must send the capture request before the authorization expires. By default, authorizations expire in 30 minutes, but the expiration period for new authorizations may be extended up to 7 days in your merchant dashboard.

If you tokenize a customer, then the customer will have the option to agree to allow you to process future transactions on their behalf. This gives you the ability to preapprove, authorize, and capture future transactions on behalf of the customer.

Session Object

A valid session object contains at a minimum an Order object or a Customer object with tokenize set to true.

URL Object

This is used for both the cancel and complete URL objects

Customer object

Address Object

This format is used for both billing_address and shipping_address in the Customer object.

Order object

Item Object

Discount Object

Metadata Object

Use the metadata object for any additional information you would like to attach to the checkout. All values must be strings.

Shipping Amount Object

A price object

Tax Amount Object

A price object

Price Object

The price object is used for items, discounts, shipping amount, tax amount, and order amount.

Notification Object

A valid notification object contains at a minimum a phone or an email.

Get a session

GET https://gateway.sezzle.com/v2/session/{session_uuid}

You can retrieve the details of an existing session using this endpoint.

Response Body

{
  "uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9",
      "method": "GET",
      "rel": "self"
    }
  ],
  "order": {
    "uuid": "12a34bc5-6de7-890f-g123-4hi1238jk902",
    "intent": "CAPTURE",
    "checkout_url": "https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
        "method": "GET",
        "rel": "self"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
        "method": "PATCH",
        "rel": "self"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release",
        "method": "POST",
        "rel": "release"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture",
        "method": "POST",
        "rel": "capture"
      },
      {
        "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund",
        "method": "POST",
        "rel": "refund"
      }
    ]
  },
  "tokenize": {
    "token": "7ec98824-67cc-469c-86ab-f9e047f9cf1a",
    "expiration": "2020-04-27T14:46:59Z",
    "approval_url": "https://dashboard.sezzle.com/customer/checkout-approval?merchant-request-id=3f3244fd-78ce-4994-af0c-b8c760d47794",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/token/7ec98824-67cc-469c-86ab-f9e047f9cf1a/session ",
        "method": "GET",
        "rel": "token"
      }
    ]
  }
}

Orders

Use the orders endpoints to get order details, update an order, release an amount by order, capture an amount by order, or refund an amount by order.

Get an order

GET https://gateway.sezzle.com/v2/order/{order_uuid}

Use this endpoint to get details on an existing order

Response Body

{
  "uuid": "12a34bc5-6de7-890f-g123-4hi1238jk902",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
      "method": "GET",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
      "method": "PATCH",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release",
      "method": "POST",
      "rel": "release"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture",
      "method": "POST",
      "rel": "capture"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund",
      "method": "POST",
      "rel": "refund"
    }
  ],
  "intent": "AUTH",
  "reference_id": "ord_12345",
  "description": "sezzle-store - #12749253509255",
  "metadata": {
    "location_id": "123",
    "store_name": "Downtown Minneapolis",
    "store_manager": "Jane Doe"
  },
  "order_amount": {
    "amount_in_cents": 10000,
    "currency": "USD"
  },
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "customer": {
    "email": "john.doe@sezzle.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "5555045294",
    "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": "5555045294"
    },
    "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": "5555045294"
    }
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 10000,
      "currency": "USD"
    },
    "approved": true,
    "expiration":"2020-04-23T16:13:44Z" ,
    "releases": [
      {
        "uuid": "4b4d217c-18f1-4bfb-996e-767470c04661",
        "amount": {
          "amount_in_cents": 3000,
          "currency": "USD"
        }
      }
    ],
    "captures": [
      {
        "uuid": "f4415e94-e562-47cc-94f3-92279f27dc20",
        "amount": {
          "amount_in_cents": 7000,
          "currency": "USD"
        }
      }
    ],
    "refunds": [
      {
        "uuid": "83162d2f-d5f1-43ad-91ed-e8231920ce6d",
        "amount": {
          "amount_in_cents": 1000,
          "currency": "USD"
        }
      }
    ]
  } 
}

Update an order

PATCH https://gateway.sezzle.com/v2/order/{order_uuid}

Use this endpoint to update an existing order. Only the reference ID can be updated.

Request Body

{
  "reference_id": "ord_9876"
}

Update Order Object

There is no response body for this request. If successful, we return an HTTP 204 Status No Content.

Release amount by order

POST https://gateway.sezzle.com/v2/order/{order_uuid}/release

Use this endpoint to release an amount by order.

Header Parameters

Request Body

{
  "amount_in_cents": 5000,
  "currency": "USD"
}

Release Order Object

A price object

Price Object

Response Body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8"
}

Capture amount by order

POST https://gateway.sezzle.com/v2/order/{order_uuid}/capture

Use this endpoint to capture an amount by order.

Header Parameters

Request Body

{
  "capture_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  },
  "partial_capture": true
}

Capture Amount By Order Object

Capture Amount Object

A price object.

Price Object

From the time the user is redirected back to the Merchant’s site, you must make the capture request within the expiration period (30 minutes by default; see Create a session) or the authorization will be canceled by Sezzle. In the event that the authorization is canceled, we will return a rejection response with Status 422.

Success Response Body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8"
}

Refund amount by order

POST https://gateway.sezzle.com/v2/order/{order_uuid}/refund

Use this endpoint to refund an amount by order

Header Parameters

Request Body

{
  "amount_in_cents": 5000,
  "currency": "USD"
}

Refund Amount Object

A price object.

Price Object

Response Body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8"
}

Delete checkout by order

DELETE https://gateway.sezzle.com/v2/order/{order_uuid}/checkout

Use this endpoint to delete a checkout for an order. The request fails if the checkout has already been successfully completed by the customer.

If you have redirected the customer to the Sezzle checkout and subsequently cancel the order in your ecommerce platform, then you should immediately call this endpoint to prevent the possibility of the customer completing the Sezzle checkout.

There is no response body for this request. If successful, we return an HTTP 204 Status No Content.

Customers

Use the customers endpoints to get a list of customers, get details on an existing customer, delete a customer, preapprove an amount for the customer, or create an order for a customer.

Get a list of customers

GET https://gateway.sezzle.com/v2/customer

You can retrieve a list of existing customers using this endpoint.

Response Body

[
  {
    "uuid": "a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
    "expiration":  "2020-04-28T17:58:11Z",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
        "method": "GET",
        "rel": "self" 
      },
      {
        "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
        "method": "DELETE",
        "rel": "self" 
      },
      {
        "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2/preapprove",
        "method": "POST",
        "rel": "preapprove" 
      },
      {
        "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2/order",
        "method": "POST",
        "rel": "order" 
      }
    ]
  }
]

Get a customer

GET https://gateway.sezzle.com/v2/customer/{customer_uuid}

You can use this endpoint to get details on an existing customer

Response Body

{ 
  "uuid": "a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
      "method": "GET",
      "rel": "self" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
      "method": "DELETE",
      "rel": "self" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2/preapprove",
      "method": "POST",
      "rel": "preapprove" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2/order",
      "method": "POST",
      "rel": "order" 
    }
  ],
  "email": "john.doe@sezzle.com",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "5555045294",
  "dob": "1990-02-25",
  "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": "5555045294"
  }
}

Delete a customer

DELETE https://gateway.sezzle.com/v2/customer/{customer_uuid}

You can use this endpoint to delete an existing customer

There is no response body for this request. If successful, we return an HTTP 204 Status No Content.

Preapprove amount by customer

POST https://gateway.sezzle.com/v2/customer/{customer_uuid}/preapprove

You can use this endpoint to preapprove an amount for a customer

Request Body

{
  "amount_in_cents": 5000,
  "currency": "USD"
}

Preapprove Object

A price Object

Price Object

Response Body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8",
  "approved": true
}

Create order by customer

POST https://gateway.sezzle.com/v2/customer/{customer_uuid}/order

You can use this endpoint to create an order for a customer

Header Parameters

Request Body

{
  "intent": "AUTH",
  "reference_id": "monthly_sub_123",  
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  }
}

Order Payment Object

Order Amount Object

A price object. The amount must be greater than 99.

Price Object

Response Body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "GET",
      "rel": "self" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "PATCH",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/release",
      "method": "POST",
      "rel": "release" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/capture",
      "method": "POST",
      "rel": "capture" 
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/refund",
      "method": "POST",
      "rel": "refund" 
    },
  ],
  "intent": "AUTH",
  "reference_id": "monthly_sub_123",  
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 5000,
      "currency": "USD"
    },
    "approved": true,
    "expiration":"2020-04-23T16:13:44Z"
  }
}

Tokenization

Use the token endpoints to get the status of a customer tokenization

Get session tokenization

GET https://gateway.sezzle.com/v2/token/{token}/session

You can use this endpoint to get the current state of a session (tokenize) token

If the customer is not tokenized, then the customer object will be omitted.

Response Body

{
  "token": "4f8cf865-2089-4423-85fd-ea833a16b62d",
  "expiration": "2020-04-29T19:31:54Z",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/token/4f8cf865-2089-4423-85fd-ea833a16b62d/session",
      "method": "GET",
      "rel": "self" 
    }
  ],
  "customer": {
    "uuid": "a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
    "expiration": "2020-10-13T14:29:41Z",
    "links": [
      {
        "href": "https://gateway.sezzle.com/v2/customer/a9d8e15c-5e4a-4201-aa8f-7540f934a9a2",
        "method": "GET",
        "rel": "self" 
      }
    ]
  }
}

Reports

Settlement Reports

These endpoints allow you to view a list of payout summaries or a detailed report of an individual payout.

Settlement Summaries Response Body

[
    {
        "uuid": "b7916fbe-f30a-4435-b411-124634287a8ca",
        "payout_currency": "USD",
        "payout_date": "2019-12-09T15:52:33Z",
        "net_settlement_amount": 9370,
        "forex_fees": 0,
        "status": "Complete"
    },
    {
        "uuid": "c51343hba-d54b-5641-e341-15235523b3at",
        "payout_currency": "USD",
        "payout_date": "2019-12-10T15:52:33Z",
        "net_settlement_amount": 23470,
        "forex_fees": 0,
        "status": "Complete"
    }
]

Settlement Summaries Request

GET https://gateway.sezzle.com/v2/settlements/summaries

Settlement Details Response

total_order_amount,total_refund_amount,total_fee_amount,total_returned_fee_amount,total_chargeback_amount,total_chargeback_reversal_amount,total_interest_transfer_amount,total_correction_amount,total_referral_revenue_transfer_amount,total_bank_account_withdrawals,total_bank_account_withdrawal_reversals,forex_fees,net_settlement_amount,payment_uuid,settlement_currency,payout_date,payout_status
703.20,-5.00,-43.80,.30,0.00,0.00,-4.30,1.71,10.00,100.00,-100.00,0.00,693.61,a5c13qt1-4126-41d3-2fq8-9ca431f51431,USD,2019-11-02 00:05:00 +0000 UTC,Complete
type,order_capture_date,order_created_at,event_date,order_uuid,customer_order_id,external_reference_id,amount,posting_currency,type_code,chargeback_code,sezzle_order_id
ORDER,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-10-22T19:09:50Z,bm99f-31vu1-kg00e-rae1g,1,12345,500.00,USD,001,,66d78e86-fd96-4266-9217-b769c102a0a0
ORDER,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-10-22T19:09:50Z,va13d-474s9-3000e-nungg,13,12346,200.00,USD,001,,5e0d4886-8c3d-4d4e-901a-2046a06c1e0f
ORDER,2019-11-01T20:00:01Z,2019-11-01T00:00:01Z,2019-11-01T00:00:01Z,as41g-4v4s9-3000e-nunh0,1,12347,1.40,USD,001,,a2c1a142-96ad-48c9-93d2-1acaaee9f073
ORDER,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,as62l-5ptqs-9g00e-pvk10,2,12348,1.80,USD,001,,3f62dcba-f5a4-41be-ad8f-53e938b5f310
FEE,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,bm99f-31vu1-kg00e-rae1g,1,12345,-30.00,USD,003,,66d78e86-fd96-4266-9217-b769c102a0a0
FEE,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,va13d-474s9-3000e-nungg,13,12346,-12.00,USD,003,,5e0d4886-8c3d-4d4e-901a-2046a06c1e0f
FEE,2019-11-01T20:00:01Z,2019-11-01T00:00:01Z,2019-11-01T20:00:01Z,as41g-4v4s9-3000e-nunh0,1,12347,-1.20,USD,003,,a2c1a142-96ad-48c9-93d2-1acaaee9f073
FEE,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,as62l-5ptqs-9g00e-pvk10,2,12348,-0.60,USD,003,,3f62dcba-f5a4-41be-ad8f-53e938b5f310
REFUND,2019-10-22T19:09:50Z,2019-10-22T19:09:50Z,2019-11-01T19:09:50Z,bm5rm-vg2js-1tsky-c2dsky,8,12344,5.00,USD,002,,e4194956-de70-4958-9da4-6c05f276fdab
RETURNED_FEE,2019-10-22T19:09:50Z,2019-10-22T19:09:50Z,2019-11-01T19:09:50Z,bm5rm-vg2js-1tsky-c2dsky,7,12344,.30,USD,004,,e4194956-de70-4958-9da4-6c05f276fdab
CORRECTION,,,2019-11-01T17:00:01Z,,,,-1.29,,007,
CORRECTION,,,2019-11-01T17:00:01Z,,,,3.00,,007,
INTEREST_TRANSFER,,,2019-11-01T18:00:01Z,,,,-4.30,,008,
REFERRAL_REVENUE_TRANSFER,,,2019-11-01T15:00:01Z,,,,10.00,,009,
BANK_ACCOUNT_WITHDRAWAL,,,2019-11-02T00:05:00Z,,,,100.00,,010,
BANK_ACCOUNT_WITHDRAWAL_REVERSAL,,,2019-11-02T00:05:00Z,,,,-100.00,,011,

Settlement Details Request

GET https://gateway.sezzle.com/v2/settlements/details/{payout_uuid}

The settlement details response contains two sections. The first two rows are a summary of the payout. The remaining rows contain the individual line items that contributed to the payout.

Summary column definitions:

Line item column definitions:

Line item event type definitions:

Interest Account Reports

Sezzle gives merchants the option to enroll in an interest account program. If you are enrolled in the interest account program, you can use these endpoints to get the current balance and activity on the interest account. Fractions of cents are tracked to properly calculate daily interest accrual even if the interest balance is low.

Interest Account Balance Response Body

{
  "interest_balance": 5183.4624
}

Interest Account Balance Request

GET https://gateway.sezzle.com/v2/interest/balance

Interest Account Activity Response Body

type,event_date,interest_account_change_amount,interest_account_balance_after_change
INTEREST_PAYOUT,2019-12-21T19:10:00Z,122.8718,5101.4676 
INTEREST_WITHDRAWAL,2019-12-21T19:20:00Z,-26.1000,5075.3676 
INTEREST_ACCRUAL,2019-12-21T19:15:00Z,1.0702,5182.3922
INTEREST_ACCRUAL,2019-12-22T19:15:00Z,1.0702,5183.4624

Interest Account Activity Request

GET https://gateway.sezzle.com/v2/interest/activity

Webhooks

You can use these endpoints to configure and test your webhooks

Create webhooks

POST https://gateway.sezzle.com/v2/webhooks

This endpoint can be used to subscribe to webhooks

Request Body

{
  "url": "https://example.com/webhooks",
  "events": [
    "customer.tokenized"
  ]
}

Webhooks Object

Response Body

{
  "uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
  "links": [
  ]
}

Valid Webhook Events

We accept the following Webhook events

List webhooks

GET https://gateway.sezzle.com/v2/webhooks

You can get a list of your webhooks using this endpoint

Response Body

[
  {
    "uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
    "links": [
      {}
    ],
    "url": "https://example.com/webhooks",
    "events": [
      "customer.tokenized"
    ]
  }
]

Delete Webhooks

DELETE https://gateway.sezzle.com/v2/webhooks/{webhooks_uuid}

You can delete your webhooks using this endpoint

There is no response body for this request. If successful, we return an HTTP 204 Status No Content.

Test Webhooks

POST https://gateway.sezzle.com/v2/webhooks/test

You can trigger a test event using this endpoint

Test Webhooks Object

There is no response body for this request. If successful, we return an HTTP 201 Status Created.

Webhook Signature

Webhooks are signed with an HMAC using the SHA256 algorithm. The header Sezzle-Signature value is a hash of the webhook’s body with your merchant private key. You should always verify that the signature matches the webhook data to ensure that the webhook came from Sezzle.

Webhook Acceptance and Retries

A webhook has been successfully sent when we receive an HTTP 200 Status OK response. Any other response will queue the webhook to be retried. We will retry several times within the first hour, and a few times for the remainder of that day. The final two attempts are made one day later, and then 3 days later, for a total elapsed time of five days. If the final retry fails, then that subscribed webhook will be deleted for all events. You will need to create the webhook again to resubscribe, if desired.

It is possible that new webhooks will arrive before old webhooks have been retried, so webhooks are not guaranteed to be received in cronological order.

Webhooks are signed using the current merchant private key, not the private key at the time of their creation, so a retried webhook may have a different signature if the keys are changed after its originating event.

Errors

v2 endpoints will return an array of standardized error objects.

We attempt to keep these errors as consistent as possible, and will announce any changes in advance if they are required.

Error Response Body

[
  {
    "code": "invalid",
    "location": "order.amount.amount_in_cents",
    "message": "Order amount must be greater than $0.99",
    "debug_uuid": "919f40d0-874b-4d98-810d-ed2246a8ad77"
  }
]

Javascript SDK

The Javascript SDK is for creating an in-context checkout by hosting the Sezzle checkout in a modal iframe or pop-up window.

Features

• Create Checkout
• Capture Payment
• Supports Sezzle Checkout in an iframe, pop-up window, or redirect to Sezzle
• Handle Payment Success
• Handle Payment Cancel
• Handle Payment Failure
• Render Sezzle Button

Installing the SDK

• Include https://checkout-sdk.sezzle.com/checkout.min.js in the <head> section of the page.

Implement the SDK

Button Configuration

Button Placeholder

<div id="sezzle-smart-button-container"></div>

• Create a placeholder element for the Sezzle Button to be rendered on the page(s).

Button Customization

<div id="sezzle-smart-button-container" style="text-align: center"
     templateText="Pay with %%logo%%"
     borderType="semi-rounded"
     customClass="action,primary,checkout">
</div>

• Use HTML attributes to customize the button.

Checkout Configuration

Configure Checkout

const checkout = new Checkout({
    'mode': "iframe",
    'publicKey': "xxxx",
    'apiMode': "sandbox",
    'apiVersion': "v2"
});

• Edit the page file to implement the SDK.
• Configure the SDK with the following options:
  

Render the Sezzle Button

Render Button

checkout.renderSezzleButton("sezzle-smart-button-container");

Call renderSezzleButton passing the id of the placeholder element defined in Button Configuration, above.

Initialize the Checkout

Initialize Checkout

checkout.init({
    onClick: function () {},
    onComplete : function (event) {},
    onCancel: function () {},
    onFailure: function (event) {}
});

The SDK requires the following event handlers:

Hosting the Checkout

To be implemented in the onClick handler. There are two methods for hosting a checkout.

Start Checkout with URL

checkout.startCheckout({
    checkout_url: "https://checkout.sezzle.com/?id=example"
});

• Use an existing checkout url.

Start Checkout with Payload

checkout.startCheckout({
  checkout_payload: {
    "order": {
      "intent": "AUTH",
      "reference_id": "ord_12345",
      "description": "sezzle-store - #12749253509255",
      "order_amount": {
        "amount_in_cents": 10000,
        "currency": "USD"
      }
    }
  }
});

• Use a checkout payload as detailed in the Session Object.
  • The cancel and complete urls are not required for iframe and popup mode.
  • Tokenization is not supported in the SDK.

Checkout Events

• A successfully completed Sezzle checkout will trigger an event to the onComplete handler. The event should include a data object with the session_uuid and order_uuid.
• If the user exits the Sezzle checkout for any reason, the onCancel handler will be executed.
• Any error will trigger an event to the onFailure handler. The event should include a data object with the error details.

Checkout Completed

function onCompleteHandler(event) {
  var data = event.data || Object.create(null);

  console.log('checkout data:',
    data.session_uuid,
    data.order_uuid);
}

checkout.init({
    onComplete : onCompleteHandler
});

Capture the Order

Typically implemented in the onComplete handler. Capturing an order is not required if the CAPTURE intent was used when creating the checkout.

The capture payment method requires two parameters, the order_uuid and the payload as detailed in the Capture Amount By Order Object.

Capture Order

var payload = {
  capture_amount: {
      amount_in_cents: 5000,
      currency: "USD"
  },
  partial_capture: false
};

checkout.capturePayment(data.order_uuid, payload);

Mobile SDK

The Mobile SDK is for integrating the Sezzle checkout and widget into a native mobile app.

Android

The Android SDK is available in Gradle or Maven.

iOS

The iOS SDK is available in CocoaPods.

Widget SDK

Purpose

The Widget SDK serves to load our sales widgets to web pages. The widgets will not show unless a config is provided before the script is loaded. The repository for this project can be found at https://github.com/sezzle/sezzle-js.

Configuring the Widgets

An example of how to configure the widget:

    document.sezzleConfig = 
    {
        targetXPath: ['.price'],
        renderToPath: ['..'],
        urlMatch: 'product',
        theme: 'light',
        scaleFactor: 1.0,
        logoSize: 1.00,
        logoStyle: {'margin': '0px 0px -4px 1px','transformOrigin': 'center top'},
        altVersionTemplate: {
          'en': 'or 4 interest-free payments of %%price%% with %%logo%% %%info%%',
          'fr': 'ou 4 paiements de %%price%% sans intérêts avec %%logo%% %%info%%'
        },
        splitPriceElementsOn: '-',
        ignoredPriceElements: ['.Price-compareAt'],
        ignoredFormattedPriceText: ['Subtotal', 'Total:', 'Sold Out'],
        hideClasses: ['.afterpay-paragraph'],
        fontFamily: 'inherit',
        fontSize: 12,
        fontWeight: 300,
        color: 'inherit',
        alignment: 'auto',
        alignmentSwitchMinWidth: 768,
        alignmentSwitchType: 'center',
        lineHeight: '13px',
        maxWidth: 400,
        marginTop: 0,
        marginBottom: 0,
        marginLeft: 0,
        marginRight: 0,
        language: navigator.language,
        forcedShow: false
    }

Only the targetXPath is required in the local config. Each key using the default value may be removed from the sezzleConfig, and the default values will be used automatically.

The config must be specified in a property of the document object called document.sezzleConfig. The SDK also provides various options to customize the widget’s position and appearance. The explanation for all the options can be found below:

targetXPath (required)

Purpose: Path to the element in the webpage where the product price text value will be detected.
Type: string, or array of strings
Default: “
Additional Details: Specify one path if only one price element is targeted. Specify multiple paths in an array if multiple price elements are targeted. The path may contain multiple subpaths. All subpaths need to be separated by the ‘/’ character. IDs need to be preceded by a ‘#’ character. Classes needed to be preceded by a ‘.’ character. Tag names need to be followed by the applicable index. The format of a tagname is as follows: tagName-Index (e.g. ‘SPAN-2’). The indexes are zero-based, such that the first element of the specified type within the parent element is at index 0.

Example: ‘#ProductSection/.product-price/SPAN-1’ would target the 2nd ‘SPAN’ element contained within elements that contain the ‘product-price’ class which are contained within the element with an ID of ‘ProductSection’.

An example of targetXPath:

<div id="ProductSection">
    <div class="product-price">
        <span>Price: </span>
        <span>$15.99</span>
    </div>
</div>
<script type="text/javascript">
    document.sezzleConfig = {
        targetXPath: '#ProductSection/.product-price/SPAN-1'
    }
</script>

renderToPath (optional)

Purpose: Path to the element in the webpage relative to targetXPath where the Sezzle widget should be rendered.
Type: string, or array of strings
Default: ‘..’
Additional Details: Path to the element below which the widget should render (widget’s previous element sibling). If you wish to place widgets in multiple places, you can pass multiple paths in an array. The price path at the nth index of the targetXPath array will be rendered at the path given at the nth index of the renderToPath array. If you do not pass anything to the nth index of the renderToPath array but there is a path at the nth index of targetXPath, then the widget will default to be rendered directly below the parent of the corresponding target element.
‘./’ will place the widget as the next element sibling of the target element.
‘../’ means go up one parent element.
As with targetXPath, prepend IDs with ‘#’, classes with ‘.’, and append tag names with the index (tagName-Index). It is recommended to keep the renderToPath as simple as possible to maximize compatibility.

urlMatch (optional)

Purpose: Specific word appearing in the url of pages where the widget config should be applied.
Type: string
Default: ”
Additional Details: Typical values are ‘product’ or ‘cart’, as applicable

theme (optional)

Purpose: Updates the logo color to coordinate and contrast with different background colors of websites.
Type: string
Options: dark, light, grayscale, black-flat, white, white-flat
Default: ‘light’

scaleFactor (optional)

Purpose: Ratio at which to scale the Sezzle widget.
Type: number
Default: 1.0

logoSize (optional)

Purpose: Ratio at which to scale the Sezzle logo.
Type: number
Default: 1.00
Additional Details: The space the logo occupies between the widget text and the More Info link/icon is determined by the font size. When dramatically scaling the widget, it may be necessary to override the styling to adjust the left and right margins of the logo using logoStyle.

logoStyle (optional)

Purpose: Custom styling to apply to the Sezzle logo within the widget, particularly when using logoSize.
Type: object
Default: {}
Additional Details: The object will accept any CSS styling in JSON format. Keys must be surrounded by “, given in camelCase instead of kebob-case, and separated from the following key by a comma instead of a semi-colon.

altVersionTemplate (optional)

Purpose: Text content of the widget. Also changes the arrangement of price, logo, and the info/learn-more icon within the widget.
Type: string, or object
Default: {en: ‘or 4 interest-free payments of %%price%% with %%logo%% %%info%%’, fr: ‘ou 4 paiements de %%price%% sans intérêts avec %%logo%% %%info%%’}
Additional Details: Currently available templates: %%price%%, %%logo%%, %%link%%, %%info%%, %%question-mark%%, %%line-break%%

splitPriceElementsOn (optional)

Purpose: Character or string at which to split the price elements (for elements with price ranges).
Type: string
Default: ”
Additional Details: Certain websites, especially WooCommerce websites, have price ranges as their price element (e.g. $650 - $1000). Setting this field to the character or string which separates the prices (e.g. in the case above, it is ’-’) enables the widgets to parse the price elements separately. For instance, setting this field to ’-’ would cause the widget to render the widget price above as $162.50 - $250.00.

An example of splitPriceElementsOn:

<div class="price">
    <span class="woocommerce-Price-amount">$12</span>
    " - "
    <span class="woocommerce-Price-amount">$15</span>
</div>
<script type="text/javascript">
    document.sezzleConfig = {
        targetXPath: '.price/.woocommerce-Price-amount',
        splitPriceElementsOn: '-',
        relatedElementActions: [{
            relatedPath: '.',
          initialAction:(e, t)=> {
              if(e.nextSibling&&" – "===e.nextSibling.textContent) {
          let i=(e.nextElementSibling.innerText.replace(",", "").substr(1)/4).toFixed(2);
          t.getElementsByClassName("sezzle-price-split")[0].innerText+=" - $"+i
              }
          }
        }, 
        {
            relatedPath: '.',
            initialAction:(e, t)=> {
        e.previousSibling&&" –" ===e.previousSibling.textContent&&(t.style="display: none")
            }
        }]
    }
</script>

ignoredPriceElements (optional)

Purpose: Child elements of targetXPath to be disregarded when detecting the price and rendering the widget.
Type: array of strings
Default: []
Additional Details: ignoredPriceElements can be used to solve targetXPath variations between sale and regular-priced items. In this case, targetXPath should point to the parent element surrounding the old and the new prices, then ignoredPriceElements will specify the old/compare-at price element. As with targetXPath, prepend IDs with ‘#’, classes with ‘.’, and append tag names with the index (tagName-Index).

An example of ignoredPriceElements:

<span class="ProductMeta__PriceList">
    <span class="product__price--regular">$20</span>
    <span class="product__price--sale">$15</span>
</span>
<script type="text/javascript">
    document.sezzleConfig = {
        targetXPath: '.ProductMeta__PriceList',
        ignoredPriceElements: ['.product__price--regular']
    }
</script>

ignoredFormattedPriceText (optional)

Purpose: Text strings within the targetXPath to be disregarded when detecting the price and rendering the widget.
Type: array of strings
Default: [‘Subtotal’, ‘Total:’, ‘Sold Out’]

hideClasses (optional)

Purpose: Classes of elements that should be hidden when Sezzle’s logo is showing. This is useful for hiding a product similar to Sezzle that is not available in a country where Sezzle is.
Type: array of strings
Default: []

fontFamily (optional)

Purpose: Font family of the widget text.
Type: string
Default: ‘inherit’

fontSize (optional)

Purpose: Font size of the widget text in pixels.
Type: number
Default: 12
Additional Details: Enter numbers only. Do not enter the unit (e.g. px)!

fontWeight (optional)

Purpose: Boldness of the widget text.
Type: number
Default: 300
Additional Details: 100 is the lightest, 900 is the boldest.

color (optional)

Purpose: Color of the widget text.
Type: string
Default: ‘inherit’
Additional Details: Accepts all kinds of values (hexadecimal, rgb(), hsl(), etc…)

alignment (optional)

Purpose: Alignment of the widget relative to the parent element.
Type: string
Options: left, center, right, auto
Default: ‘auto’

alignmentSwitchMinWidth (optional)

Purpose: Screen width in pixels below which the alignment switches to alignmentSwitchType instead of alignment.
Type: number
Default: 0
Additional Details: The most common breakpoint is 768 (handheld vs desktop). alignmentSwitchMinWidth is typically only necessary when alignment is not auto.

alignmentSwitchType (optional)

Purpose: Alignment of the widget relative to the parent element to be applied when the viewport width is narrower than alignmentSwitchMinWidth.
Type: string
Options: left, center, right, auto
Default: ‘auto’

lineHeight (optional)

Purpose: Content height of the widget.
Type: string
Default: ‘13px’
Additional Details: Include unit (e.g.: px)

maxWidth (optional)

Purpose: Maximum width of the widget element in pixels.
Type: number
Default: 400
Additional Details: 200 to render the widget nicely on 2 lines, 120 for 3 lines.

marginTop (optional)

Purpose: Amount of space above the widget in pixels.
Type: number
Default: 0

marginBottom (optional)

Purpose: Amount of space below the widget in pixels.
Type: number
Default: 0

marginLeft (optional)

Purpose: Amount of space left of the widget in pixels.
Type: number
Default: 0

marginRight (optional)

Purpose: Amount of space right of the widget in pixels.
Type: number
Default: 0

language (optional)

Purpose: Language in which the widget text should be rendered.
Type: string
Options: ‘en’, ‘fr’
Default: navigator.language
Additional Details: To match the selected language in the window instead of the user’s default browser language, use document.querySelector(‘html’).lang. Currently, the SDK only supports ‘en’ and ‘fr’

forcedShow (optional)

Purpose: Shows the widget in every country if true. Shows the widget in only the United States and Canada if false.
Type: boolean
Options: false, true
Default: false

Uploading the Widgets

After building up the config, it is time to upload the widgets to your webpages! The SDK needs to be called in the HTML of the webpage in order for the widgets to be rendered. Place the config and the widget script at the bottom of the code file for the HTML page, and you should be all set!

Placing the following code snippet into your HTML loads the SDK into the webpage.

<script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid={{replace_with_your_merchant_id}}"></script>

The script reflecting the applicable merchant ID must be called only after the config is specified (document.sezzleConfig is defined). Here is a complete example:

<script type="text/javascript">
    document.sezzleConfig = 
      {
        targetXPath: ['.price'],
        renderToPath: ['..'],
        urlMatch: 'product',
        theme: 'light',
        scaleFactor: 1.0,
        logoSize: 1.00,
        logoStyle: {'margin': '0px 0px -4px 1px','transformOrigin': 'center top'},
        altVersionTemplate: {
          'en': 'or 4 interest-free payments of %%price%% with %%logo%% %%info%%',
          'fr': 'ou 4 paiements de %%price%% sans intérêts avec %%logo%% %%info%%'
        },
        splitPriceElementsOn: '-',
        ignoredPriceElements: ['.Price-compareAt'],
        ignoredFormattedPriceText: ['Subtotal', 'Total:', 'Sold Out'],
        hideClasses: ['.afterpay-paragraph'],
        fontFamily: 'inherit',
        fontSize: 12,
        fontWeight: 300,
        color: 'inherit',
        alignment: 'auto',
        alignmentSwitchMinWidth: 768,
        alignmentSwitchType: 'center',
        lineHeight: '13px',
        maxWidth: 400,
        marginTop: 0,
        marginBottom: 0,
        marginLeft: 0,
        marginRight: 0,
        language: navigator.language,
        forcedShow: false
    }
</script>
<script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid=12a34bc5-6de7-890f-g123-4hi5678jk901"></script>

The “simple” configuration above is intended for a single template of code (product or cart page) individually. Alternatively, a single configuration could be created for the entire webpage using an array of objects called configGroups. The script will determine which configGroup(s) applies to the active webpage and render the widget(s) accordingly.

<script type="text/javascript">
document.sezzleConfig = {
  configGroups: [
    {
        targetXPath: ['.price'],
        renderToPath: ['..'],
        urlMatch: 'product',
        theme: 'light',
        scaleFactor: 1.0,
        logoSize: 1.00,
        logoStyle: {'margin': '0px 0px -4px 1px','transformOrigin': 'center top'},
        altVersionTemplate: {
          'en': 'or 4 interest-free payments of %%price%% with %%logo%% %%info%%',
          'fr': 'ou 4 paiements de %%price%% sans intérêts avec %%logo%% %%info%%'
        },
        splitPriceElementsOn: '-',
        ignoredPriceElements: ['.Price-compareAt'],
        ignoredFormattedPriceText: ['Subtotal', 'Total:', 'Sold Out'],
        hideClasses: ['.afterpay-paragraph'],
        fontFamily: 'inherit',
        fontSize: 12,
        fontWeight: 300,
        color: 'inherit',
        alignment: 'auto',
        alignmentSwitchMinWidth: 768,
        alignmentSwitchType: 'center',
        lineHeight: '13px',
        maxWidth: 400,
        marginTop: 0,
        marginBottom: 0,
        marginLeft: 0,
        marginRight: 0
    },
    {
      targetXPath: '.cart__subtotal',
      renderToPath: '../..', 
      urlMatch: 'cart',
    }
  ],
  forcedShow: false,
  language: document.querySelector('html').lang || navigator.language,
}
</script>
<script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid=12a34bc5-6de7-890f-g123-4hi5678jk901"></script>

Testing

While you are working on the integration, you should test it before going live. Please use this section for information on testing.

Sandbox

API Endpoint https://sandbox.gateway.sezzle.com/v2
Sandbox Dashboard https://sandbox.dashboard.sezzle.com/merchant

Test Data

You can use the following test data to test your integration

Card

Card Number 4242424242424242
CVV/CVC any (3 numbers)
Expiration Date any
Name any
Address any

Phone and other information

1. Please use any valid US or CA phone number.
2. The expected OTP is 123123.
3. Personal information does not need to be real.

Open API

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

Specification

View the Sezzle v2 OpenAPI Specification.

Client Generator

The OpenAPI Specification can be imported into the Swagger Editor to easily generate a Sezzle client in a variety of programming languages. If your language is not supported by Swagger, an alternate tool is OpenAPI Generator.

Platform Integrations

BigCommerce

This guide describes how to integrate Sezzle into your BigCommerce website so that you can provide Sezzle as a payment option for your customers. After integrating Sezzle, your BigCommerce site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your BigCommerce order management system.
3. Display Sezzle promotional messaging.
4. Authorize and capture payments.

This integration is only available with BigCommerce’s Optimized One Page Checkout.

Integration Steps Overview

1. Enable Sezzle as an online payment method
2. Install and configure the Sezzle BigCommerce App
3. Test your integration
4. (Optional) Sandbox Testing

Before You Begin

1. You should have a Sezzle merchant account.
   • Please visit our signup page if you don’t have an account.
2. Make sure you have the following Sezzle details handy.
   • Merchant ID
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Enable Sezzle as an online payment method

1. Go to Store Setup > Payments.
   
2. Go to Online Payment Methods, find Sezzle and click Set up.
   
3. Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields.
   
4. Select the Transaction Type.
   • Note: If you select Authorize only, payment will only be authorized and will have to be captured later in BigCommerce.
     
5. Select the Test Mode: No(Recommended), or Yes for testing.
   
6. Click on Save.
   

Install the Sezzle BigCommerce App

1. Log in to your website’s BigCommerce store admin page.
2. In the left sidebar, click Apps > Marketplace.
3. Click BigCommerce.com/Apps.
4. Search for Sezzle.
5. Click Sezzle, then click Get This App.
6. Click Install.
7. Check the PCI Compliance box, then click Confirm to start the installation.

BigCommerce Sandbox Testing

1. Select the Test Mode as Yes from Sezzle Settings in Payments section of BigCommerce admin. Make sure you are doing this on your dev/staging website.
2. On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Place Order and you should be redirected to the Sezzle checkout page. If prompted, sign in.
4. Enter the payment details using test data, then click Complete Order.
5. After the payment is completed on Sezzle, you should be redirected back to your website and see a successful payment page.
6. Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

BigCommerce Live Checkout

1. Select the Test Mode as No(Recommended) from Sezzle Settings in Payments section of BigCommerce admin.
2. On your website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Place Order.
4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
5. Warning Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Widget Pre-Configuration

1. Make sure you have the Sezzle App installed in your store.
   
2. Go to Apps > Sezzle.
   
3. Copy your Merchant ID from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle App of your BigCommerce admin.
   
4. Check the Add Sezzle Widget Script box. This will inject the widget script into the product and cart pages of your store.
   
5. Save the configuration.
   
6. Go to Storefront > Script Manager. Confirm that the Sezzle Widget scripts appear in the list of installed scripts.
   
7. Widget is now ready to be configured.
   
8. For finalizing the widget configuration, click Request Addition of Widgets in the widget step of your Sezzle Merchant Dashboard Setup Checklist.

Troubleshooting

If testing was unsuccessful, review the following:

• Site has Optimized One-Page Checkout enabled.
  • Go to Advanced Settings > Checkout.
• API Keys were entered correctly.
  • To avoid typos or extra spaces, use the Copy icon in the Sezzle Merchant Dashboard.
  • If you have multiple accounts with Sezzle, each store has its own merchant ID and API Keys that are tied to the store’s URL.
• Add Sezzle Widget Script box is checked.
• Widget script is present on your website and reflects the Merchant IDfrom your Sezzle Merchant Dashboard.
  • Go to a product page on your website.
  • Right-click then select Inspect.
  • In the Elements tab, search for widget.sezzle.

Manual Theme Integration

If the Sezzle App fails to maintain the widget script on the product pages, or to add the script manually for additional pages, complete the following steps:

1. Go to Storefront > Script Manager.
2. Click the Create a Script button.
3. Set Name of script to Sezzle Widget.
4. Set Location on page to Footer.
5. Set Select pages where script will be added to All pages.
6. Set Script category to Essential.
7. Set Script type to Script.
8. In the Script content area, copy+paste the script, then click Save.

The script to be inserted into your webpage is as follows:

Template: <script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid={sezzle_merchant_uuid}"></script>

Example: <script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid=12a34bc5-6de7-890f-g123-4hi5678jk901"></script>

Instructions may vary slightly depending on your active plug-ins. If the issue persists after completing the above steps, look for other available features that allow the addition of a custom HTML code snippet to the site footer. If no such feature is found, the below steps may be followed as a last resort:

1. Go to Storefront > My Themes.
2. In your Current Theme, click Advanced then select Edit Theme Files.
3. In the confirmation window, click Edit Theme Files.
4. In the file list, go to templates > pages, then select product.html.
5. Copy+paste the script into the very bottom of the file, then click Save and Apply Files.
6. Repeat the previous step for the cart.html file.

For any kind of assistance, reach out to merchantsupport@sezzle.com.

Uninstall Steps

1. Go to Apps > My Apps.
2. Under the Sezzle App, click Uninstall.
3. Toggle the button against Sezzle under Store Setup>Payments>Online Payment Methods to disable Sezzle as a payment option.

Lightspeed

This guide describes how to integrate Sezzle into your Lightspeed website so that you can provide Sezzle as a payment option for your customers.

Sezzle’s Lightspeed App is certified and available here in the App Store.

After integrating Sezzle, your Lightspeed site will:

• Offer Sezzle as a payment option on the checkout page.
• Refund Sezzle payments from your Lightspeed backend.
• Display Sezzle promotional messaging.
• Authorize and capture payments.

Integration Steps Overview

1. Install and configure the Sezzle Lightspeed App
2. Test your integration
3. (Optional) Sandbox Testing

Before You Begin

1. You should have a Sezzle merchant account.
   • Please visit our signup page if you don’t have an account.
2. Make sure you have the following Sezzle details handy.
   • Merchant ID
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Lightspeed App

• Log in to your Lightspeed back office.
• Navigate to Apps > App Store.
• Search for Sezzle in the search bar and click on the Sezzle app.
• Click on Install App in the top right corner.
• Grant permission by clicking on Grant access.
• On successful install, you will be redirected to Sezzle App.

Configure Sezzle

Navigate to the Sezzle App by clicking on Go to App located at Apps > Purchased Apps > Sezzle.

Account Verification

• Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields.
• Click on link sezzle account to link your Sezzle account with your Lightspeed store.
  • The message Account successfully linked is displayed when the account is verified.

Settings

• Toggle the Sezzle at Checkout checkbox to enable (On) or disable (Off) Sezzle as a payment option in the checkout page.
• Toggle the Sezzle Widgets checkbox to enable (On) or disable (Off) Sezzle widget in the PDP and Cart pages.

Payment Refund

• In your Lightspeed back office, go to Orders > Orders.
• Select the order to be refunded.
• Click Add Credit Invoice.
  • Select the item and enter the quantity.
  • Ensure that Status is set to Not Paid.
  • Click Add.
• Cancelling a Paid order will also refund the payments for the Paid Invoices.
• On successful refund:
  • An invoice with the status of Not Paid will be created in the Orders > Invoices section.
  • The Order Status will be displayed as Refunded in your Sezzle Merchant Dashboard.

Lightspeed Sandbox Testing

1. A Lightspeed test store must be used for Sandbox testing.
2. On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Buy to be redirected to the Sezzle checkout page. If prompted, sign in.
4. Enter the payment details using test data, then click Complete Order.
5. After the payment is completed on Sezzle, you should be redirected back to your website and see a successful payment page.
6. Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

Lightspeed Live Checkout

1. Installing the Sezzle App in a live Lightspeed store will result in live checkouts.
2. On your website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Buy.
4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
5. Warning Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Magento 2

This guide describes how to integrate Sezzle into your Magento 2 website so that you can provide Sezzle as a payment option for your customers.

Sezzle’s Magento 2 extension is certified in the marketplace and can also be downloaded from github.

After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your Magento 2 order management system.
3. Display Sezzle promotional messaging.
4. Authorize and capture payments.
5. Offer instant and delayed capture.

Integration Steps Overview

1. Install and configure the Sezzle Magento 2 extension
2. Test your integration
3. (Optional) Sandbox Testing

Before You Begin

1. You should have a Sezzle merchant account.
   • Please visit our signup page if you don’t have an account.
2. Make sure you have the following Sezzle details handy.
   • Merchant ID
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Magento 2 Extension

In the following section, [magento] refers to your Magento 2 root directory.

Using the Composer

Go to the Magento 2 installation directory, then run the below commands:

1. composer require sezzle/sezzlepay
2. php bin/magento setup:upgrade
3. php bin/magento setup:di:compile
4. php bin/magento setup:static-content:deploy
5. php bin/magento cache:clean

Manual Method

1. Download the .zip file from Sezzle’s github repository.
2. Unzip the file
3. Navigate to Magento [Magento]/app/code/ using SFTP or SSH.
4. Copy Sezzle directory from unzipped folder to [Magento]/app/code/.
5. Open a terminal window and run the following command to enable Sezzle:
   • php bin/magento module:enable Sezzle_Sezzlepay
6. Run the Magento setup upgrade:
   • php bin/magento setup:upgrade
7. Run the Magento Dependencies Injection Compile:
   • php bin/`magento` setup:di:compile
8. Run the Magento Static Content deployment:
   • php bin/magento setup:static-content:deploy
9. Log in to Magento Admin and navigate to System > Cache Management.
10. Flush the cache storage by selecting Flush Cache Storage.

You can now directly navigate from the Configuration Page to get signed up for Sezzle. To do so, you need to click on Register for Sezzle which will redirect you to the Sezzle Merchant Signup Page. If you have the details already, you can simply click on I've already set up Sezzle, I want to edit my settings to move ahead.

1. In your Magento 2 [Magento]/app/code/ directory, create a directory named Sezzle.
2. Inside the new Sezzle directory, create a directory named Sezzlepay.
3. Inside the new Sezzlepay directory, extract the files from this repository.
4. Open the command line and run these commands:
   • php bin/magento module:enable Sezzle_Sezzlepay
   • php bin/magento setup:upgrade
   • php bin/magento setup:di:compile
   • php bin/magento setup:static-content:deploy
5. Log in to your Magento 2 admin and go to System/Cache Management.
6. Flush the cache storage by selecting Flush Cache Storage.

Upgrade the Magento 2 Extension

Using the Composer

1. Open terminal and navigate to Magento root path.
2. Execute the following commands in the terminal:
   • composer update sezzle/sezzlepay
   • php bin/magento setup:upgrade
   • php bin/magento setup:di:compile
   • php bin/magento setup:static-content:deploy
   • php bin/magento cache:clean

Configure Sezzle

Payment Configuration

• In the Magento admin site, navigate to Stores > Configuration > Sales > Payment Methods > Sezzle > Payment Settings
• Select the Payment Mode: Live, or Sandbox for testing.
• Enter your Merchant UUID, Public Key and Private Key. These can be found at the Sezzle Merchant Dashboard.
• Select the Payment Action. Authorize only will only authorize payment and requires that the payment be captured later. Authorize and Capture will perform both in a single step.
• Set the Merchant Country as per the origin.
• Set Min Checkout Amount to restrict Sezzle payment method below that amount.
• Set Payment from Applicable Countries to Specific Countries.
• Set Payment from Specific Countries to United States or Canada as Sezzle is currently available for US and Canada only.
• Select Enable Customer Tokenization. Yes prompts the customer to allow their account to be tokenized. See Customer tokenization
• Save the configuration and clear the cache.

In-Context Configuration

• Set Enable In-Context Solution to Yes to enable In-Context Checkout.
• Set In-Context Checkout Mode to IFrame or PopUp to select how Sezzle Checkout is hosted.

Settlement Report Configuration

• Set Enable Settlement Reports to Yes to enable the Settlement Reports Dashboard.
• Set Range to a value based on which you want to fetch the Settlement Reports.
• Set Enable Automatic Syncing to fetch the Settlement Reports asynchronously. (Note that this requires cron to be enabled.)
• Set Schedule and Time of Day for the automatic sync to run.

Widget Configuration

• Set Enable Static Widget Module to Yes to load the Sezzle Widget from your server, or No to load it from the Sezzle server.
• Set Enable Widget in PDP to Yes when adding the widget script in the Product Display Page, helping to enable the Sezzle Widget Modal in PDP.
• Set Enable Widget in Cart Page to Yes when adding the widget script in the Cart Page, helping to enable Sezzle Widget Modal in the Cart Page.
• Save the configuration and clear the cache.

Developer Configuration

• Enable the log tracker to trace the Sezzle checkout process.
• Set Send Logs to Sezzle to Yes to send the logs to Sezzle on a periodic basic. (Note that this requires cron to be enabled.)
• You may download the latest logs by clicking on Sezzle Log.
• Save the configuration and clear the cache.

Your store is now ready to accept payments through Sezzle.

Frontend Functionality

• When you have correctly set up Sezzle, you will see Sezzle as a payment method in the checkout page.
• Select Sezzle and continue.
• Click Continue to Sezzle or Place Order to be redirected to the Sezzle Checkout to complete the checkout. If your account is tokenized, skip the next two steps, you will not be redirected to Sezzle.
• [Optional] To tokenize your account in the Sezzle checkout, check the box Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard.
• Click Complete Order to complete your purchase.
• On successful order placement, you will be redirected to the order confirmation page.

Capture Payment

• If Payment Action is set to Authorize and Capture, capture will be performed instantly from the extension after order is created and validated in Magento.
• If Payment Action is set to Authorize, you will need to capture the payment manually from the Magento admin using the following steps:
  • Go the order and click on Invoice.
  • Verify your input in the Create Invoice page and click on Save to create the invoice.
  • This will automatically capture the payment in Sezzle.

Refund Payment

• Go to Sales > Orders in the Magento admin.
• Select the order for which you want to refund the payment.
• Click on Credit Memo and verify your input in the Create Credit Memo page.
• Save it to initiate the refund in Sezzle.
• Check the Order Status in the Sezzle Merchant Dashboard. Refunded indicates that payment has been fully refunded while Partially Refunded indicates that the payment has been partially refunded.

Release Payment

• Go to Sales > Orders in the Magento admin.
• Select the order for which you want to release the payment.
• Click on Void and confirm your action.
• Check the Order Status in Sezzle Merchant Dashboard. Deleted due to checkout not being captured before expiration indicates that the payment has been fully released. Magento does not support partial releases.

Order Verification in Magento Admin

• Log in to Magento admin, navigate to Sales > Orders, and select the order to verify.
• If Order Status is Processing and Total Paid equals Grand Total, then payment was successfully captured by Sezzle.
• If Order Status is Pending and Total Paid does not equal Grand Total, then payment is authorized but yet not captured.
• If Order Status is Closed, then payment has been refunded.
• If Order Status is Canceled, then payment has been released.

Order Verification in Sezzle Merchant Dashboard

• Log in to Sezzle Merchant Dashboard, navigate to Orders, and select the order to veriy.
• Approved status indicates that payment was successfully captured by Sezzle.
• Authorized, uncaptured indicates that payment was authorized but yet not captured.
• Refunded status indicates that the payment was refunded.
• Deleted due to checkout not being captured before expiration status indicates that either the payment was not captured before the authorization expired, or that the payment has been released.

Customer Tokenization Details

• Log in to Magento admin, navigate to Customers > All Customers, and select the customer to view tokenization details.
• If the customer is tokenizard, the Sezzle tab will appear.
• The Customer UUID, Expiration Date and Status will appear on the tab.

Settlement Reports

• Log in to Magento admin and navigate to Reports > Sales > Sezzle Settlement. A list of recent Settlement Reports will be shown.
• To make a quick sync, enter the From and To Date and click on Sync.
• Click on Download from the Action column to download a Settlement Report.
• To view details of a particular Settlement Report, click on View from the Action column. You may also download the Settlement Report details from the Settlement Report view.
• You can download the Settlement Report in CSV or Excel format.

Magento 2 Sandbox Testing

• In the Sezzle configuration page of your Magento admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and set the Payment Mode to Sandbox, and save the configuration. Make sure you are doing this on your dev/staging website.
• On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
• To pay with Sezzle:
  • If customer is not tokenized, click Continue to Sezzle.
  • If customer is tokenized, click Place Order.
  • If In-Context checkout, click Pay with Sezzle.
• For In-Context checkout, the Sezzle checkout will be hosted in the configured mode, iFrame or Popup. Otherwise, you will be redirected to the Sezzle checkout.
• Sign In or Sign Up to continue.
• Enter the payment details using test data, then advance to the final page.
• Check the Approve {Website Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard to tokenize your account.
• If your account is tokenized, the order will be placed without redirection. Otherwise you will be redirected to Sezzle Checkout to complete the purchase.
• After payment is completed at Sezzle, you will be directed to your site’s successful payment page.
• Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

Magento 2 Live Checkout

1. In the Sezzle configuration page of your Magento 2 admin, enter the API Keys from your Sezzle Merchant Dashboard and disable Sandbox/Test as the API Mode, then save the configuration.
2. On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Place Order.
4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
5. Warning Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Troubleshooting

If testing was unsuccessful, review the following:

• Sezzle-Magento2 extension is the latest version.
• Sezzle extension is enabled.
  • Go to System > Configuration > Sales > Payment Methods > Sezzle and ensure Enabled dropdown is reflecting Yes.
• Merchant ID was entered correctly.
• API Keys were entered correctly.
  • It is recommended to use the Copy icon in the Sezzle Merchant Dashboard to avoid typos or extra spaces.
    
  • If you have multiple accounts with Sezzle, the merchant ID and API Keys are tied to only one URL.
• Cache Storage was flushed.
• Widget script is present on your website and reflects the Merchant ID from your Sezzle Merchant Dashboard.
  • Go to a product page on your website.
  • Right-click then select Inspect.
  • In the Elements tab, search for widget.sezzle.

Mojo

This guide describes how to integrate Sezzle into your Mojo website so that you can provide Sezzle as a payment option for your customers. After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your Mojo order management system.
3. Display Sezzle promotional messaging.
4. Authorize and capture payments.

Integration Steps Overview

1. Add Sezzle to your store as a payment method
2. Test your integration

Before You Begin

1. You should have a Sezzle merchant account.
2. Make sure you have the following Sezzle details handy.
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Add Payment Method

1. Log into your Mojo admin account and navigate to the Integrations tab.
2. Select Payment Systems in the dropdown menu and click on Sezzle in the next window.
3. Toggle Enable to ‘ON’.
4. Next, toggle Test Mode to ‘OFF’ unless you are testing your integration in Sandbox. For Sandbox testing instructions, see Mojo sandbox testing.
5. Next, enter your Sezzle Public and Private Key within the appropriate fields.
6. In order to ensure consistency between your webpage offers and payment options upon final checkout, take a moment to navigate to your Site Settings to enable or disable those features that you want enabled with Sezzle.
   • NOTE: the Hide pay-over-time solutions switch will be automatically hidden for those customers that choose the multi-pay order option.
7. Once satisfied with your transaction flow, click the blue Save Changes button.

Mojo Sandbox testing

1. In the Sezzle Payment Systems configuration page of your Integrations tab, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard.
2. Next, toggle Test Mode to ‘ON’, then save the configuration. Make sure you are doing this on your dev/staging website.
3. On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
4. Complete the Mojo checkout process, and you should be redirected to the Sezzle checkout page. If prompted, sign in.
5. Enter the payment details using test data, then click Complete Order.
6. After the payment is completed on Sezzle, you should be redirected back to your website and see a successful payment page.
7. Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

Mojo Live Checkout

1. On your store website, add an item to your cart, then proceed to checkout and select Sezzle as the payment method.
2. Follow the Mojo checkout process until you are redirected to Sezzle.
3. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
   Warning: Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

PrestaShop

This guide describes how to integrate Sezzle into your PrestaShop website so that you can provide Sezzle as a payment option for your customers. Additionally, it includes steps to upgrade existing integrations to the latest version of the module.

Sezzle’s PrestaShop module is certified and can be downloaded from here.

After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your PrestaShop back office.
3. Authorize and capture payments.
4. Offer instant and delayed capture.

Integration Steps Overview

1. Install and configure the Sezzle PrestaShop Module
2. Test your integration
3. (Optional) Sandbox Testing

Before You Begin

1. You should have a Sezzle merchant account.
   • Please visit our signup page if you don’t have an account.
2. Make sure you have the following Sezzle details handy.
   • Merchant ID
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle PrestaShop Module

1. Download the .zip or tar.gz file from here.
2. Log in to PrestaShop back office and navigate to Modules > Module Manager.
3. Click on Upload a module and select the downloaded file.
4. Under Payment > Payment methods, confirm Sezzle has been installed.
5. Click on the Enable Module button to activate the module.

Upgrade the Sezzle PrestaShop Module

1. Uninstall the existing Sezzle module.
   • In the Upgrade drop-down menu select Uninstall.
2. If the /sezzle folder is not removed from the /modules folder when uninstalling above, remove it manually.
3. Install the latest plugin version as described in Installation step.
4. Configure the latest plugin version as described in Configuration step.

Reinstall the Sezzle PrestaShop Module

When you reinstall the plugin, the plugin handles most of the configuration and functions except for the items listed below. The recommended steps below ensure that the settings from the previous installation are removed.

• Order status
  • The plugin keeps the Awaiting Sezzle Payment order status because existing orders might still use this status. If you would like to remove this status, first confirm the status is no longer assigned to any order.
  • To check if the status is in use:
    • Go to the Orders page in your PrestaShop back office.
    • Filter the orders for the Awaiting Sezzle Payment status.
    • If results are found, change these orders to another status as needed.
  • When there are no more orders using the Awaiting Sezzle Payment status, you can delete the status from your order status list.
• Configurations
  • The plugin keeps the AWAITING_SEZZLE_PAYMENT configuration fields in your database in case there are still orders in your system with this status. If you have already removed the status (above), you can also remove the residual configurations.

Configure Sezzle

Module Configuration

• In your PrestaShop back office, go to Modules > Module Manager.
• In the Payment section, find Sezzle and select Configure.
• Fill out the following fields:
  • Live Mode : Uses Sezzle production, otherwise Sezzle sandbox for testing.
  • Merchant Id : Enter the Merchant Id from the Sezzle Merchant Dashboard.
  • Public Key : Enter the Public Key from the Sezzle Merchant Dashboard.
  • Private Key : Enter the Private Key from the Sezzle Merchant Dashboard.
  • Payment Action : Authorize and Capture immediately captures payment when a Sezzle checkout is completed and the order is created in PrestaShop. Authorize Only authorizes payment when a Sezzle checkout is completed, and the merchant must send a capture request from the back office to complete payment. If this capture request is not sent before the authorization expires, the order is canceled.
  • Allow Customer Tokenization : Offers returning shoppers a faster checkout experience by bypassing the Sezzle checkout.
  • Enable Widget : Displays Sezzle widgets on the PDP and Cart Pages.

Your store is now ready to accept payments through Sezzle.

Frontend Functionality

• If you have successfully installed the Sezzle module, then Sezzle will be included as a payment method in the checkout page.
• Select Sezzle and continue.
• Click Place Order to be redirected to the Sezzle Checkout to complete the checkout. If your account is tokenized, skip the next two steps, you will not be redirected to Sezzle.
• [Optional] To tokenize your account in the Sezzle checkout, check the box Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard.
• Finally, click on Complete Order to complete your purchase.
• On successful order placement, you will be redirected to the order confirmation page.

Capture Payment

• In your PrestaShop back office, go to Orders > Orders.
• Select the order for which you want to capture the payment.
• In the Payment section right below, enter the following information and click Add
  • Date
  • Payment method
  • Amount
• Change the Order Status to Payment Accepted if capture is successful.

Refund Payment

• In your PrestaShop back office, go to Orders > Orders.
• Select the order for which you want to refund the payment.
• Click on Partial Refund
  • Enter the refund amount(s)
    • For a full refund, you have to enter all amounts related to the order.
  • Click on Partial Refund
  • Change the Order Status to Refunded only if the refund is successful.

Release Payment

• In your PrestaShop back office, go to Orders > Orders.
• Select the order for which you want to release the payment.
• Change the Order status to Cancelled.
• Click on Update Status.

Order Verification in PrestaShop Back Office

Merchants should always check the payment status and amount of all orders. The following steps ensure that each action has been completed as expected.

• Log in to PrestaShop back office and navigate to Orders > Orders.
• Proceed into the corresponding order.
• Payment is successfully captured by Sezzle when:
  • Current Order Status is Payment Accepted.
  • Captured Amount equals the Authorized Amount.
• Payment is only authorized when:
  • Current Order Status is Awaiting Sezzle Payment.
  • Authorized Amount equals the Order Amount.
  • Captured Amount equals 0.00.
• Payment is refunded when:
  • Current Order Status is Refunded.
  • Refunded Amount is equal to or less than the Captured Amount.
• Payment is released when:
  • Current Order Status is Cancelled.
  • Amount will be deducted from Authorized Amount and should appear in Released Amount.

Order Verification in Sezzle Merchant Dashboard

• Log in to the Sezzle Merchant Dashboard and navigate to Orders.
• Proceed into the corresponding order.
• Payment successfully captured has a status of Approved.
• Payment authorized but not captured has a status of Authorized, uncaptured.
• Payment refunded has a status of Refunded or Partially refunded.
• Payment released or not captured before the authorization expired has a status of Deleted due to checkout not being captured before expiration.

PrestaShop Sandbox Testing

• In the Sezzle settings page of your dev/staging PrestaShop back office, disable Live Mode, enter the sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and save the configuration.
• On your website, add an item to the cart, then proceed to checkout and select Sezzle as the payment method.
• Click Place Order to be redirected to the Sezzle Checkout to complete the checkout. If your account is tokenized, skip the next four steps, you will not be redirected to Sezzle.
• Sign In or Sign Up to continue.
• Enter the payment details using test data, then continue to final page.
• [Optional] Check the Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard to tokenize your account.
• Finally, click on Complete Order to complete your purchase.
• Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

PrestaShop Live Checkout

1. In the Sezzle settings page of your PrestaShop back office, enable the Live mode, enter the API Keys from your Sezzle Merchant Dashboard and save the configuration.
2. On your website, add an item to the cart, then proceed to checkout and select Sezzle as the payment method.
3. Click Place Order.
4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
5. Warning Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Salesforce Commerce Cloud

This guide describes how to integrate Sezzle into your Salesforce Commerce Cloud website so that you can provide Sezzle as a payment option for your customers. This integration supports sites built with both the SiteGenesis and Reference Architecture. After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your order management system.
3. Display Sezzle promotional messaging.
4. Authorize and capture payments.

Please contact our team at dev@sezzle.com to request installation documentation for the Salesforce cartridge.

Shopware 5

This guide describes how to integrate Sezzle into your Shopware 5 website so that you can provide Sezzle as a payment option for your customers. Additionally, it includes steps to upgrade existing integrations to the latest version of the plugin.

Sezzle’s Shopware 5 plugin can be downloaded from github.

After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your Shopware 5 backend.
3. Authorize and capture payments.
4. Offer instant and delayed capture.

Integration Steps Overview

1. Install and configure the Sezzle Shopware 5 Plugin
2. Test your integration
3. (Optional) Sandbox Testing

Before You Begin

1. You should have a Sezzle merchant account.
   • Please visit our signup page if you don’t have an account.
2. Make sure you have the following Sezzle details handy.
   • Merchant ID
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Shopware 5 Plugin

In the following section, [Shopware] refers to your Shopware 5 root directory.

Using the Composer

Go to the Shopware 5 installation directory, then run the below commands:

1. Open terminal and navigate to Shopware root path.
2. Run the below command for the adding the plugin into your codebase: composer require sezzle/shopware5

Manual Method

1. Download the .zip or tar.gz file from Sezzle's github repository.
2. Unzip the file.
3. Navigate to Shopware [Shopware]/custom/plugins/ either through SFTP or SSH.
4. Copy SwagPaymentSezzle directory from unzipped folder to [Shopware]/custom/plugins/.
5. Log in to Shopware 5 Backend and navigate to Configuration > Plugin Manager > Management > Installed.
6. Find Sezzle from the Uninstalled list and click on the + button to install the plugin.
7. Once installed, you will see Sezzle under Inactive list. Click on the x button to activate the plugin.
8. After successful activation, you will be able to see Sezzle under Configuration > Payment Methods.

Upgrade the Shopware 5 Plugin

Using the Composer

1. Change the version number of the sezzle/sezzlepay inside composer.json.
2. Open terminal and navigate to Shopware root path.
3. Run the following command for the updating the plugin to a newer version: composer update sezzle/sezzlepay

Manual Method

1. Download the .zip or tar.gz file from Sezzle's github repository.
2. Unzip the file.
3. Delete the contents from [Shopware]/custom/plugins/SwagPaymentSezzle.
4. Copy the contents of SwagPaymentSezzle directory from unzipped folder to [Shopware]/custom/plugins/SwagPaymentSezzle/.
5. Log in to Shopware Backend and navigate to Configuration > Cache/performance.
6. Flush the cache storage by selecting Clear shop cache.

Configure Sezzle

Payment Configuration

• Make sure you have the Merchant UUID and the API Keys from the Sezzle Merchant Dashboard. You must be registered with Sezzle to access the Merchant Dashboard.
• Navigate to Customers > Payments > Sezzle > Settings in your Shopware Backend.
• Enable Sezzle by checking the Enable for this shop checkbox.
• Set the Public Key and Private Key.
• For testing, enable the Sandbox mode by checking the Enable sandbox checkbox.
• You can also verify your API Keys by clicking on the Test API Settings button.
• Set the Merchant UUID.
• Set the Merchant Location as per the store origin.
• Check the Enable Tokenization checkbox to enable customer tokenization in the Sezzle checkout. If the customer agrees to be tokenized, then future checkouts for this customer will not require a redirect to Sezzle. See Customer tokenization
• Set Payment Action as Authorize only for doing payment authorization only and Authorize and Capture for doing instant capture.
• Check the Enable Widget in PDP checkbox to add the widget script and the Sezzle Widget Modal to the Product Display Page.
• Check the Enable Widget in Cart checkbox to add the widget script and the Sezzle Widget Modal to the Cart Page.
• Check the Display errors checkbox for showing up Sezzle related error code in the web URL on failure.
• Set Logging to ERROR to log only error messages or ALL to log all messages, including errors, warnings, and notices.
• Save the settings and clear the cache.

Your store is now ready to accept payments through Sezzle.

Frontend Functionality

• If you have successfully installed the Sezzle plugin, then Sezzle will be included as a payment method in the checkout page.
• Select Sezzle and continue.
• Click Complete Payment to be redirected to the Sezzle Checkout to complete the checkout. If your account is tokenized, skip the next two steps, you will not be redirected to Sezzle.
• [Optional] To tokenize your account in the Sezzle checkout, check the box Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard.
• Finally, click on Complete Order to complete your purchase.
• On successful order placement, you will be redirected to the order confirmation page.

Capture Payment

• If Payment Action is set to Authorize and Capture, capture will be performed instantly from the plugin after order is created and validated in Shopware.
• If Payment Action is set to Authorize, capture needs to be performed manually from the Shopware backend. Follow the below steps to capture.
  • Go the order and click on Sezzle tab.
  • Enter a value in Amount field and click on Capture to capture the payment in Sezzle.

Refund Payment

• Go the order and click on Sezzle tab.
• Enter a value in Amount field and click on Refund to refund the payment in Sezzle.

Release Payment

• Go the order and click on Sezzle tab.
• Enter a value in Amount field and click on Release to release the payment in Sezzle.

Order Verification in Shopware Backend

Merchants should always check the payment status and amount of all orders. The following steps ensure that each action has been completed as expected.

• Log in to Shopware admin and navigate to Customers > Orders.
• Proceed into the corresponding order.
• Payment is successfully captured by Sezzle when:
  • Current Payment Status is Completely Paid.
  • Capture Amount equals the Auth Amount.
• Payment is only authorized when:
  • Current Payment Status is Open.
  • Auth Amount equals the Order Amount.
  • Capture Amount equals 0.
• Payment is refunded when:
  • Current Payment Status is Re-crediting.
  • Refund Amount is equal to or less than the Capture Amount.
• Payment is released when:
  • Current Payment Status is The process is cancelled for a full release or Open for a partial release.
  • Amount will be deducted from Auth Amount and should appear in Released Amount.

Order Verification in Sezzle Merchant Dashboard

• Log in to Sezzle Merchant Dashboard and navigate to Orders.
• Proceed into the corresponding order.
• Payment successfully captured has a status of Approved.
• Payment authorized but not captured has a status of Authorized, uncaptured.
• Payment refunded has a status of Refunded or Partially refunded.
• Payment released or not captured before the authorization expired has a status of Deleted due to checkout not being captured before expiration.

Customer Tokenization Details

• Log in to Shopware Backend and navigate to Customers > Customers.
• Select customer to view tokenization details.
• Sezzle Customer UUID, Sezzle Customer UUID Expiry and Sezzle Customer UUID Status will appear under Free text fields.

Shopware 5 Sandbox Testing

• In the Sezzle settings page of your Shopware Backend, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and check the Enable sandbox checkbox, then save the configuration. Make sure you are doing this on your dev/staging website.
• On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
• Once you click Complete Payment, you will be redirected to Sezzle Checkout to complete the checkout. Note: If your account is tokenized, skip the next four steps as you will not be redirected to Sezzle.
• Sign In or Sign Up to continue.
• Enter the payment details using test data, then continue to final page.
• [Optional] To tokenize your account in the Sezzle checkout, check the box Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard.
• Finally, click on Complete Order to complete your purchase.
• Sandbox testing is complete. You can log in to your Sezzle Merchant Sandbox Dashboard to see the test order you just placed.

Shopware 5 Live Checkout

1. In the Sezzle settings page of your Shopware Backend, enter the API Keys from your Sezzle Merchant Dashboard and uncheck the Enable sandbox checkbox, then save the configuration.
2. On your website, add an item to the cart, then proceed to Checkout and select Sezzle as the payment method.
3. Click Complete Payment.
4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
5. Warning Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Troubleshooting

• Sezzle plugin creates logs of Sezzle action.
• In the event that Merchant Success and Support teams are unable to resolve any issue, the Merchant may request that these logs be forwarded to the Platform Integrations team for further troubleshooting..
• Logs are named as plugin_dev-<current-date>.log. To facilitate troubleshooting, we recommend sending thecore_dev-<current-date>.log as well..
• Logs can be find in [Shopware]/var/log/.

Wix

This guide describes how to integrate Sezzle into your Wix website so that you can provide Sezzle as a payment option for your customers. After integrating Sezzle, your site will:

1. Offer Sezzle as a payment option on the checkout page.
2. Refund Sezzle payments from your Wix order management system.
3. Display Sezzle promotional messaging.
4. Authorize and capture payments.

Integration Steps Overview

1. Add Sezzle to your store as a payment method
2. Test your integration

Before You Begin

1. You should have a Sezzle merchant account.
2. Make sure you have the following Sezzle details handy.
   • Public API Key
   • Private API Key
3. Familiarize yourself with the transaction flow when buying with Sezzle.

Add Payment Method

1. From your Wix store dashboard, select Settings, and Accept Payments.
2. Choose the See More Payment Options link at the bottom of the page.
3. Locate Sezzle in the list, and choose Connect. This takes you to the Connect Sezzle page.
4. Enter your API Keys from the Sezzle Merchant Dashboard, and choose Connect. Sezzle will now be available as a payment method at checkout.

Wix Live Checkout

1. On your store website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
2. Follow the Wix checkout process to the final step and choose Place Order.
3. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
   Warning: Don’t complete the payment. Your checkout is now live, so you will be charged if you complete it.

Troubleshooting

For account connection problems, check the following:

• API Keys were entered correctly.
  • To avoid typos or extra spaces, use the Copy icon in the Sezzle Merchant Dashboard.
  • If you have multiple accounts with Sezzle, each store has its own merchant ID and API Keys that are tied to the store’s URL.

If Sezzle does not appear as a payment option during live testing:

• Ensure that Sezzle is activated as a payment provider on your site.
  • Go to Settings > Accept Payments and ensure that “Accepting Payments” is displayed for Sezzle.