Merchant Guide v1

Sezzle Merchant Guide v1

Introduction (v1)

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

The Sezzle API v1 is intended for merchants interested in accepting Sezzle as a payment option. The Sezzle Integration Flow illustrates the user payment interaction.

Sezzle supports individually authorized transactions for a single purchase of goods or services.

Sezzle offers integrations with some of the most popular eCommerce platforms.

Note that v2 indicates support for v2 API only.

Please choose your platform to see the relevant documentation:

  1. 3DCart
  2. BigCommerce v2
  3. Bold Cashier
  4. BuyItLive
  5. CommentSold
  6. Magento 1
  7. Magento 2 v2
  8. Mojo v2
  9. NopCommerce
  10. Salesforce Commerce Cloud v2
  11. Shopify
  12. Shopware 5 v2
  13. Wix v2
  14. WooCommerce
  15. Zoey

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 here: Submit Merchant Help Request

You should have an approved Sezzle account to start the integration process. Please visit our signup page if you don't have a Sezzle account already.

Integration Flow

Overview of Integration Flow

payment flowpayment flow

Explanation of payment flow

  1. Merchant calls /v1/checkouts to send cart data to Sezzle.
  2. Sezzle returns URL to redirect consumer to make payment at Sezzle checkout.
  3. Merchant redirects the consumer to Sezzle.
  4. When the consumer completes the Sezzle checkout flow, they are redirected back to merchant's website.
  5. Alternatively, on approval, the consumer is redirected from Sezzle checkout to merchant's website and merchant captures the order by calling /v1/complete.

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/v1/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

You must replace the tokens you obtain from the Sezzle Authorization endpoint every 120 minutes. However, we do not restrict you to a single token, and you can obtain a new one at any time.

Configuration

Setting your configuration

Request Body

{
    "webhook_url": "https://yourdomain.com/webhook"
}

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

POST https://gateway.sezzle.com/v1/configuration

At this time, Sezzle only allows configuration of the URL that we send our webhooks to.

ParameterTypeDescription
webhook_url*stringA URL for us to send our webhooks to.

Checkouts

Create a Checkout

Request Body

{
    "amount_in_cents": 12999,
    "currency_code": "USD",
    "order_reference_id": "Ref123456789",
    "order_description": "Order #1800",
    "checkout_cancel_url": "https://sezzle.com/cart",
    "checkout_complete_url": "https://sezzle.com/complete",
    "customer_details":
    {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "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"
    },
    "requires_shipping_info": false,
    "items": [
        {
          "name": "widget",
          "sku": "sku123456",
          "quantity": 1,
          "price": {
              "amount_in_cents": 1000,
              "currency": "USD"
          }
        }
    ],
    "discounts": [
        {
          "name": "20% off",
          "amount": {
              "amount_in_cents": 1000,
              "currency": "USD"
          }
        }
    ],
    "tax_amount": {
        "amount_in_cents": 1000,
        "currency": "USD"
    },
    "shipping_amount": {
        "amount_in_cents": 1000,
        "currency": "USD"
    },
    "metadata": {
        "location_id": "123",
        "store_name": "Downtown Minneapolis",
        "store_manager": "Jane Doe"
    }
}

Response Body

{
    "checkout_url": "https://checkout.sezzle.com/?id=<checkout_id>",
    "checkout_uuid": "<checkout_id>"
}

HTTP Request

POST https://gateway.sezzle.com/v1/checkouts

This checkout endpoint creates a checkout in our system, and returns the URL that you should redirect the user to.
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.

Sezzle is able to handle the entire checkout process after a Checkout has been provided. However, if your flow requires that the user confirm their checkout on
your site after being approved by Sezzle, you may include the merchant_completes parameter with the checkout request. In this flow, Sezzle will not complete the
order unless you make a checkout completion request.

Checkout Object

ParameterTypeDescription
amount_in_cents*intThe amount of the checkout. Must be at least 100
currency_code*stringThe currency code of the checkout
order_reference_id*stringA reference to this checkout in your systems
order_description*stringA user-facing description for this checkout
checkout_cancel_url*stringThe URL we should redirect the customer to in the case of a cancellation
checkout_complete_url*stringThe URL we should redirect to in the case of a successful checkout
checkout_expirationstringCheckout expiration in ISO 8601 date/time format
customer_detailsobjectThe customer in the checkout
billing_addressobjectThe billing address of the checkout
shipping_addressobjectThe shipping address of the checkout
requires_shipping_infobooleanFlag to indicate if you would like us to collect shipping information for this checkout from the customer. If omitted, will default to false
itemsarrayThe items being purchased
discountsarrayThe discounts applied. Must be included in the total
tax_amountobjectThe taxes applied to this checkout. Must be included in the total
shipping_amountobjectThe shipping fees applied to this checkout. Must be included in the total
merchant_completesbooleanFlag to determine whether this checkout must be completed by the merchant. If omitted, will default to false
metadataobjectObject for any custom data you want to submit with the checkout. You are not limited to the key-value pairs shown in the example, and you may use any key-value pairs you like
send_checkout_urlobjectA Notification object for sending checkout URL to the customer
localestringLocalizes the checkout. Accepted values are en-US (English, United States), en-CA (English, Canada), and fr-CA (French, Canada). Defaults to en-US if not provided.
Your order reference ID must be unique identifier, and may only contain 'a-Z', '0-9', '-', and '_'.

Customer Details Object

ParameterTypeDescription
first_namestringThe user's first name
last_namestringThe user's last name
emailstringThe user's email address
phonestringThe user's phone number

Address Object

This is used for both billing and shipping

ParameterTypeDescription
namestringThe name on the address
streetstringThe street and number of the address
street2stringThe apt or unit
citystringThe city
statestringThe 2 character state code
postal_codestringThe postal delivery code
country_codestringThe 2 character country code
phone_numberstringThe phone number at the delivery location

Item Object

ParameterTypeDescription
namestringThe name of the item
skustringThe sku identifier
quantityintThe quantity purchased
priceobjectThe price object

Tax Amount Object

ParameterTypeDescription
tax_amountobjectA price object

Shipping Amount Object

ParameterTypeDescription
shipping_amountobjectA price object

Discount Object

ParameterTypeDescription
namestringThe description of the discount
amountobjectA price object

Price Object

ParameterTypeDescription
amount_in_centsintThe amount of the item in pennies
currencystringThe 3 character currency code as defined by ISO 4217

Metadata Object

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

ParameterTypeDescription
some_field_namestringCustom metadata field
some_other_field_namestringCustom metadata field

Notification Object

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

ParameterTypeDescription
to_sms_phonestringThe SMS phone number of the notification
to_emailstringThe email address of the notification
languagestringThe 2-character ISO 639 langauge code of the notification. Acceptable values are "en" and "fr". Will default to English if not provided

Complete a Checkout (optional)

Success response

Echoes the given Checkout.

Rejection response

{
    "status": 409,
    "id": "checkout_expired",
    "message": "checkout not completed within time limit"
}

POST https://gateway.sezzle.com/v1/checkouts/{order_reference_id}/complete

If you pass true to merchant_completes in our Create Checkout flow, then you must call our Complete Checkout endpoint.

For some checkouts, a merchant may need to have the user return to their site for additional steps before completing the purchase. If this is the case,
the order completion endpoint is used to complete the Checkout with Sezzle. From the time the user is redirected back to the Merchant's site, you must
make the request to complete the checkout within 30 minutes, or the checkout will be canceled by Sezzle. If the checkout has expired, we will return the
rejection response on the right, with a Status 409. The default expiration period for new orders may be extended up to 7 days in your merchant dashboard.

There are two non-error responses expected. Either an HTTP 200, which echoes all accepted fields given at Checkout creation, or a rejection message.

Orders

Order Details

Order Details Response Body

{
    "created_at": "2018-11-02T20:09:59Z",
    "captured_at": "2018-11-02T20:18:50Z",
    "capture_expiration": "2018-11-02T20:48:45Z",
    "description": "Description of order",
    "amount_in_cents": 20000,
    "usd_amount_in_cents": 20000,
    "customer_amount_in_cents": 20000,
    "currency_code": "USD",
    "customer_currency_code": "USD",
    "reference_id": "Ref123456789",
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "5555045294"
    },
    "shipping_address": {
        "name": "John Doe",
        "phone_number": "5555045294",
        "street": "123 W Lake St",
        "street2": "Unit 104",
        "city": "Minneapolis",
        "state": "MN",
        "postal_code": "55408",
        "country_code": "US"
    },
    "billing_address": {
        "name": "John Doe",
        "phone_number": "5555045294",
        "street": "123 W Lake St",
        "street2": "Unit 104",
        "city": "Minneapolis",
        "state": "MN",
        "postal_code": "55408",
        "country_code": "US"
    },
    "refunds": [
      {
        "amount": {
          "amount_in_cents": 10000,
          "currency": "USD"
        },
        "created_at": "2018-11-02T20:09:59Z",
        "is_full_refund": false,
        "order_reference_id": "Ref123456789",
        "refund_id": "52b2O9Lv-8",
        "refund_reason": "broken"
      }
    ],
    "metadata": {
      "location_id": "123",
      "store_name": "Downtown Minneapolis",
      "store_manager": "Jane Doe"
    },
    "items": [
        {
          "name": "widget",
          "sku": "sku123456",
          "quantity": 1,
          "price": {
              "amount_in_cents": 1000,
              "currency": "USD"
          }
        }
    ]
}

GET https://gateway.sezzle.com/v1/orders/{order_reference_id}

Once an order is created, you can retrieve the details of the order using this endpoint.

Optional Query Parameter(s)

ParameterTypeValuesDescription
include-shipping-infostringtrue or falseIf your checkout post data required us to collect shipping information from the customer, then you can request that information alongside the order details.

Order Refunds

Refund Request Body

{
    "refund_id": "41a2O9Lv-7",
    "amount": {
        "amount_in_cents": 500,
        "currency": "USD"
    },
    "refund_reason": "Item returned by user"
}

POST https://gateway.sezzle.com/v1/orders/{order_reference_id}/refund

Sezzle allows refunds for orders either through our Merchant Dashboard or through the API.
If the refund is processed through the dashboard, a webhook will be sent to your system.
In either case, Sezzle allows for either partial or complete refunds. Refund amounts are relative to the order
total, not the amount that has been paid by the shopper.

Refund Request

ParameterTypeDescription
amount*objectA price object that defines the amount to be refunded. Amount may not be 0, negative, or exceed the total order amount. Currency must either be the order's currency or the customer's paying currency. This field is optional if the is_full_refund parameter is true.
refund_idstringUUID for the Refund. Must be unique to a Merchant.
refund_reasonstringA reason for the refund.
is_full_refundbooleanOverrides amount. If true, the order will be fully refunded. If omitted, will default to false

Reporting

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/v1/settlements/summaries

Query ParameterDescription
start-date*The UTC start date for the report. Must be in yyyy-mm-dd format.
end-dateThe UTC end date for the report. Must be in yyyy-mm-dd format. If omitted, will default to the current date.
offsetThe offset for the report. Limit is 20.
currency-codeThe ISO-4217 currency code selected by users at checkout. If omitted, will default to USD.

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/v1/settlements/details/{payout_uuid}

The payout_uuid is the uuid returned by the Settlement Summaries Response.
Query ParameterDescription
metadataAn optional comma-separated list of metadata keys. To add a metadata key as a column to the report line items, include the key in this list. When applicable, the value of the metadata key will be added to the line item. If no line items contain the metadata key, the key will not be added as a column.

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:

Column HeaderDescription
Total order amountThe sum of all orders on this payout.
Total refund amountThe sum of all refunds on this payout.
Total fee amountThe sum of all fees on this payout.
Total returned fee amountThe sum of all returned fees on this payout.
Total chargeback amountThe sum of all chargebacks on this payout.
Total chargeback reversal amountThe sum of all chargeback reversals on this payout.
Total interest transfer amountThe sum of all interest transfers on this payout. If you are not participating in the interest program, this field will be omitted.
Total correction amountThe sum of all corrections on this payout.
Total referral revenue transfer amountThe sum of all referral revenue transfers on this payout.
Total bank account withdrawal amountThe sum of all bank account withdrawals.
Total bank account withdrawal reversal amountThe sum of all bank account withdrawal reversals, which reflect a bank account withdrawal that has failed.
Forex feesThe cost of foreign exchange fees associated with this payout.
Net settlement amountNet amount of settlement.
Payment uuidThe UUID for this payout.
Settlement currencyThe currency in which this payout was sent.
Payout dateThe date this payout was sent.
Payout statusThe current status of this payout.

Line item column definitions:

Column HeaderDescription
TypeDescribes the type of event (Order, Fee, Refund, etc.).
Order capture dateThe date at which the order was captured. This field is empty if the order has not yet been captured.
Order created atThe date at which the order was created.
Event dateThe date at which the event took place.
Order uuidThe uuid associated with the order.
Customer order idThe customer's order number.
External reference idThe external reference ID submitted with the order.
AmountThe amount of the event.
Posting currencyThe customer's currency code.
Type codeA numeric code that corresponds with the Type field.
Chargeback codeA numeric code that corresponds with the type of chargeback submitted.
Sezzle order IDThe internal ID Sezzle has assigned to this order.

Line item event type definitions:

TypeDescriptionType Code
ORDERA completed order with Sezzle.001
REFUNDAn order that has been refunded.002
FEEThe fee assessed by Sezzle for a given order.003
RETURNED_FEEA fee refunded by Sezzle.004
CHARGEBACKA chargeback resulting from a disputed order.005
CHARGEBACK_REVERSALA reversal of a chargeback resulting from a disputed order.006
CORRECTIONA manual correction to a payout.007
INTEREST_TRANSFERA transfer from the Sezzle interest account.008
REFERRAL_REVENUE_TRANSFERA payment earned from Sezzle's merchant referral program.009
BANK_ACCOUNT_WITHDRAWALA withdrawal of funds from your bank to cover a negative balance with Sezzle.010
BANK_ACCOUNT_WITHDRAWAL_REVERSALA failed BANK_ACCOUNT_WITHDRAWAL.011

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/v1/interest/balance

Query ParameterDescription
currency-codeThe ISO-4217 currency code of the interest account. If omitted, will default to USD.

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/v1/interest/activity

Query ParameterDescription
start-date*The start date for the report. Must be in yyyy-mm-dd format.
end-dateThe end date for the report. Must be in yyyy-mm-dd format. If omitted, will default to the current date.
offsetThe offset for the report.
currency-codeThe ISO-4217 currency code of the interest account. If omitted, will default to USD.

Webhooks

Order Webhooks

Webhook

{
    "time": "2017-10-19T00:33:10.548372055Z",
    "uuid": "02c5a2a0-8394-4b45-80b3-52d40c494322",
    "type": "order_update",
    "event": "order_complete",
    "object_uuid": "Ref123456789",
    "refund_id": "szl-a0293Pn-3948-80b3-ao34JAia39zQ",
    "refund_amount": {
        "amount_in_cents": 500,
        "currency": "USD"
    }
}

Because the majority of a consumer's checkout process happens on Sezzle's pages, our API uses webhooks to communicate
information about checkout updates, completions, or refunds to your system.

We expect any response in the 200 range on submitting webhooks.

Order Webhook Object

ParameterTypeDescription
timestringThe time (UTC) at which the Webhook was generated.
uuidstringA unique identifier for the webhook.
typestringThe high-level category. For example, order_update
eventstringThe specific action. For example, order_complete
object_uuidstringThe ID for the Checkout/Order.
refund_idstring optionalUnique ID for a refund. Included if the webhook event is order_refund.
refund_amountobject optionalPrice object. Included if the webhook event is order_refund.
For order update webhooks, the `object_uuid` returned is the reference ID provided during checkout creation by the merchant

Order Update Events/Types

TypeEventDescription
order_updateorder_completeThe checkout was completed successfully
order_updateorder_refundThe order was refunded from the Sezzle Merchant Dashboard

Errors

Error Details

Response Error Body

{
    "status": 400,
    "id": "error_id",
    "message": "Descriptive message"
}

Unless otherwise specified in our documentation, Sezzle returns a standard API error object.

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

Error Object

ParameterTypeDescription
StatusintMatches the HTTP Status code of the response
IDstringA programmatic identifier for the error. These rarely (if at all) change.
MessagestringA human-friendly string. These may change, and are intended to assist in debugging rather than program logic.

Javascript SDK

The Javascript SDK is documented in the latest API v2 documentation. It is supported for users of the v1 API using the same loadable page script.

When using the Javascript SDK with v1, use apiVersion: "v1" in the Checkout constructor as shown in Checkout configuration.

Create a Checkout

checkout.startCheckout({
    checkout_payload: {
        "amount_in_cents": 12999,
        "currency_code": "USD",
        "order_reference_id": "Ref123456789",
        "order_description": "Order #1800",
    }
});

When using the Javascript SDK with v1, a checkout is created using the Checkout Object. The checkout is completed using the Complete a Checkout endpoint. This endpoint differs from the v2 endpoint in that it captures the total order amount and does not require a request body. Because of this, do not use the payload object shown in the example capture.

Complete a Checkout

checkout.capturePayment("Ref123456789");

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.

View our latest documentation for configuring widgets.

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/v1

Sandbox Dashboard https://sandbox.dashboard.sezzle.com/merchant

Credentials to log in to the sandbox dashboard are the ones you use to log in to the Sezzle Merchant Dashboard. You can create your test API keys in the sandbox dashboard.

Test Data

You can use the following test data to test your integration

Bank

Bank Test Bank

Username demo

Password go

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 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

Download the Sezzle OpenAPI Specification for Sandbox or Production.

Client Generator

The Sezzle OpenAPI Specification can be imported into the Swagger Editor to easily generate a Sezzle client in a variety of programming languages. Generate a Sezzle client for Sandbox or Production.

Platform Integrations

3DCart

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

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

Integration Steps Overview

  1. Install and configure the Sezzle 3DCart 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle 3DCart Extension

  1. Log in to your website's 3DCart admin.
  2. Get the app here.
  3. Copy+paste your Store URL into the input area, then click Proceed.
    application_authorizationapplication_authorization
  4. Check the PCI Compliance box, then click Acknowledge and Authorize the App to start the installation.

Admin Configuration

  1. In your 3DCart admin, go to Settings > Payment.
  2. Click Select Payment Methods.

    select_payment_methodsselect_payment_methods
  3. Turn the Sezzle switch to On.
  4. Copy your Public Key from your Sezzle Merchant Dashboard, and paste it into the corresponding field in the Sezzle configuration page of your 3DCart admin.
  5. Next to Private Key, click Change. Then, copy your Private Key from your Sezzle Merchant Dashboard, and paste it into the corresponding field in the Sezzle configuration page of your 3DCart admin.
  6. Click Save.

    sezzle_payment_configsezzle_payment_config
  7. To restrict Sezzle usage by country, click the Exclude List hyperlink under the Sezzle switch.
  8. Click Add Location.
  9. Select the desired country, then click Add.

    exclude_listexclude_list
  10. Installation is complete.

3DCart Sandbox Testing

  1. In the Sezzle configuration page of your 3DCart admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and check the Test Mode checkbox, then save the configuration. 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.
    checkoutcheckout
  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.

3DCart Live Checkout

  1. In the Sezzle configuration page of your 3DCart admin, enter the API Keys from your Sezzle Merchant Dashboard and uncheck the Test Mode checkbox, then save the configuration.
  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.
    checkoutcheckout
  4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  5. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

Troubleshooting

If testing was unsuccessful, review the following:

  • Sezzle 3DCart extension is the most updated version.
  • Sezzle payment method is enabled.
  • 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.
  • 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.

Manual Theme Integration

If the 3DCart 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. From your 3DCart admin, go to Settings > Design > Themes & Styles.
  2. In your Current Theme, click the button labeled More then select Edit Template(HTML).
  3. Find the copy of your theme under Go to Folder.
  4. Click the gear icon next to the product_items.html file, then click Edit.
  5. When the dashboard asks if you want to edit your theme files, click the Edit Theme Files button.
  6. In the Source Code text area, copy+paste the script at the very beginning of the file.
  7. 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>
Update {sezzle_merchant_uuid} in the above script template with your site’s Merchant ID (removing the curly brackets), which can be found in the Sezzle Merchant Dashboard.

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. For assistance with widget configuration, click Request Addition of Widgets in the widget step of your Sezzle Merchant Dashboard Setup Checklist.

Uninstall Steps

  1. Go to Settings > Payment.
  2. Click Select Payment Methods.
  3. Under the Sezzle App, click the gear icon then click Delete.

Bold Cashier

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

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

This integration is currently only available on Shopify.

Integration Steps Overview

  1. Install the Sezzle Bold Cashier app
  2. Test your integration

Before You Begin

  1. You should have a Sezzle merchant account.
    • Please visit our signup page if you don't have an account.
  2. You should generate API Keys using your Sezzle Merchant Dashboard
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Bold Cashier Extension

  1. First you must install the Bold Cashier app to your platform and store url. You can do this from the Bold Cashier site.
  2. Log in to your Shopify admin.
  3. Go to Apps > Bold Cashier.
    Bold cashierBold cashier
  4. In the Bold Cashier left sidebar, click Marketplace, then find Sezzle and click Install.
    Bold installBold install
  5. Click Allow to accept permissions and complete the installation.
    Bold permissionsBold permissions
  6. Installation is complete.
    Bold marketplaceBold marketplace

Bold Cashier Live Checkout

  1. On your website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
  2. Click Complete Order.
  3. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  4. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

Uninstall Steps

  1. Go to your Bold Cashier Marketplace and scroll to find Sezzle.
  2. Click Uninstall.
    Bold marketplaceBold marketplace

BuyItLive

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

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

Integration Steps Overview

  1. Add and configure the Sezzle BuyItLive App
  2. Test your integration

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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

BuyItLive Admin Configuration

  1. Log in to your website's BuyItLive admin.
  2. Click Add Payment Provider.
  3. Select Connect with Sezzle.
  4. Go to Sezzle Payments > Tools.
  5. Copy your Private Key and Public Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your BuyItLive admin.
  6. Click Save Settings.
  7. Go to Cart Settings and ensure the Sezzle switch is in the On position.
  8. Installation is complete.

BuyItLive Live Checkout

  1. On your website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
  2. Click Place Order.
  3. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  4. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

CommentSold

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

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

Integration Steps Overview

  1. Configure the Sezzle CommentSold App
  2. Test your integration

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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

CommentSold Admin Configuration

  1. In your CommentSold admin, go to Setup.
  2. Click Payment Gateways.
  3. Copy your Private Key and Public Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your CommentSold admin.
  4. Click Update Keys.
    sezzle_payment_configsezzle_payment_config
  5. Installation is complete.

CommentSold Live Checkout

  1. In the Sezzle configuration page of your CommentSold admin, enter the API Keys from your Sezzle Merchant Dashboard and uncheck the Use Sandbox checkbox, then save the configuration.
  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!
    sezzle checkoutsezzle checkout
  5. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

Magento 1

Magento 1 documentation is provided for legacy reference only. Please use Magento 2 for new projects or upgrades.

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

  1. Offer Sezzle as a payment option on the checkout page.
  2. Refund Sezzle payments from your Magento 1 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 1 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Magento 1 Extension

For the below instructions, assume [Magento] represents your root Magento directory.

  1. Download the .zip or tar.gz file from Sezzle's github repository.
  2. Unzip the file and follow the following instructions.
  3. Copy all files in the extracted folder's: /app/code/community/ to: [MAGENTO]/app/code/community.
  4. Copy all files in the extracted folder's /app/design/frontend/base/default/layout/ to: [MAGENTO]/app/design/frontend/base/default/layout.
  5. Copy all files in the extracted folder's /app/design/frontend/base/default/template/ to: [MAGENTO]/app/design/frontend/base/default/template.
  6. Copy all files in the extracted folder's: /app/etc/ to:
    [MAGENTO]/app/etc.
  7. Copy all files in the extracted folder's: /js to: [MAGENTO]/js.
  8. Log in to your Magento 1 admin and go to System/Cache Management.
  9. Flush the cache storage by selecting Flush Cache Storage.

Note : To upgrade the extension, completely remove the previously added Sezzle Magento extension files, then repeat the above steps with the updated sezzle-magento repository.

Admin Configuration

  1. Go to System > Configuration > Sales > Payment Methods > Sezzle.
  2. Configure the extension as follows:
    1. Set Enabled to Yes.
    2. Copy your Merchant ID from your Sezzle Merchant Dashboard, and paste it into the corresponding field in the Sezzle configuration page of your Magento 1 admin.
    3. Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your Magento 1 admin.
    4. Set API Mode to Live.
    5. If you want the widget script added to the Product Display Page, set Add Widget Script in PDP to Yes
    6. If you want the widget script added to the Cart Page, set Add Widget Script in Cart Page to Yes
    7. Set Payment from Applicable Countries to Specific Countries.
    8. Set Payment from Specific Countries to United States or Canada as applicable.
    9. Set Payment Action as Authorize Only to authorize the payment at the time the order is placed but capture payment later, or Authorize and Capture to both authorize and capture at the time the order is placed.
      • If Authorize Only is selected, then the capture expiry time will be visible in the Order Details page. You need to capture the payment before the given deadline by choosing Capture Online when you create the invoice.
    10. Save the configuration.
      admin sezzleadmin sezzle
  3. Go to System/Cache Management.
  4. Flush the cache storage by selecting Flush Cache Storage.
  5. Installation is complete.

Magento 1 Sandbox Testing

  1. In the Sezzle configuration page of your Magento 1 admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and set the API Mode to Sandbox/Test, then save the configuration. 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 Continue then Place Order and you should be redirected to the Sezzle checkout page. If prompted, sign in.
    onepage movementonepage movement
  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.

Magento 1 Live Checkout

  1. In the Sezzle configuration page of your Magento 1 admin, enter the API Keys from your Sezzle Merchant Dashboard and set the API Mode to Live, 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 Continue then Place Order.
    onepage movementonepage movement
  4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  5. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

Troubleshooting

If testing was unsuccessful, review the following:

  • Sezzle-Magento extension is the most updated 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.

NopCommerce

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

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

Integration Steps Overview

  1. Install and configure the Sezzle NopCommerce 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle NopCommerce Extension

Go to https://www.nopcommerce.com/sezzle and click Get Extension.

Admin Configuration

  1. Go to Configuration > Local Plugins.
  2. Click Upload Plugin or Theme and select the downloaded zipped file per the instructions given.
  3. After the extension has been uploaded, click Install.
  4. Under Configuration, go to Payment Methods and then click Configure under Sezzle.
    admin nopcommerceadmin nopcommerce
  5. Click Edit from the Payment Method list.
  6. Copy your Merchant ID from your Sezzle Merchant Dashboard, and paste it into the corresponding field in the Sezzle configuration page of your NopCommerce admin.
  7. Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your NopCommerce admin.
  8. Set Transaction Mode to either Authorize or Authorize and Capture.
  9. Save the configuration.
    admin nopcommerce sezzlepayadmin nopcommerce sezzlepay
  10. To restrict Sezzle usage based on billing country, go to Configuration > Payment Restrictions.
  11. Choose the country you want to restrict for Sezzle. Please note that Sezzle is currently available for customers from The United States and Canada. You may wish to restrict all countries where Sezzle is not available.
    admin nopcommerce_sezzlepay restrictionadmin nopcommerce_sezzlepay restriction
  12. Integration is complete.

NopCommerce Sandbox Testing

  1. In the Sezzle configuration page of your NopCommerce admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and check the Use Sandbox checkbox, then save the configuration. 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 Confirm and you should be redirected to the Sezzle checkout page. If prompted, sign in.
    onepage nopcommerce payment movementonepage nopcommerce payment movement
  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.

NopCommerce Live Checkout

  1. In the Sezzle configuration page of your NopCommerce admin, enter the API Keys from your Sezzle Merchant Dashboard and uncheck the Use 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.
    nopcommerce product pagenopcommerce product page
    nopcommerce product pagenopcommerce product page
  3. Click Continue then Confirm.
    onepage nopcommerce payment movementonepage nopcommerce payment movement
  4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  5. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.

Shopify

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

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

Integration Steps Overview

  1. Install and configure the Sezzle Shopify 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Shopify App

  1. Log in to your website's Shopify admin.
  2. In your Sezzle Merchant Dashboard Setup Checklist, click Download Shopify App.
  3. Click Get the App.
  4. Click Install App.

    install_appinstall_app

Configure Widgets

  1. Within the Sezzle app, enter your Public API Key and click link sezzle account.

    add_public_keyadd_public_key
  2. Once your account is linked, click add widgets to add widgets to your shop. This process may take a minute.

    add_widgetsadd_widgets
  3. After widgets have been added, navigate to a product page to confirm that the Sezzle widget has been added.

    product_widgetproduct_widget
  4. If you ever need to remove Sezzle widgets from your shop, click the remove widgets button within the Sezzle app.

    remove_widgetsremove_widgets

Note: If the Sezzle app is unable to automatically add widgets to your shop, one of our team members will automatically be notified and will work to manually add widgets to your shop within 7 business days.

Install the Sezzle Payment Gateway

  1. In your Sezzle Merchant Dashboard Setup Checklist, click Connect Sezzle to Shopify.
  2. Click Instructions.
  3. Click the first hyperlink on the new page to enable the gateway for your shop. If prompted, select your Shopify store.
  4. Click Install Payment Provider.

    install_payment_providerinstall_payment_provider

Admin Configuration

  1. In your Shopify admin, go to Settings > Payment Providers.

    sezzle_payment_configsezzle_payment_config
  2. Under Alternative Payment Methods, click Choose Alternative Payment.

    choose_alternative_paymentchoose_alternative_payment
  3. Search for and click on Sezzle.

    select_sezzleselect_sezzle
  4. Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your Shopify admin.
  5. Click the Activate Sezzle button.

    account_informationaccount_information
  6. Installation is complete.

Shopify Live Checkout

  1. In the Sezzle configuration page of your Shopify admin, enter the API Keys from your Sezzle Merchant Dashboard and uncheck the Enable Test Mode checkbox, then save the configuration.
  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.
    checkoutcheckout
  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.

Troubleshooting

If testing was unsuccessful, review the following:

  • Sezzle Shopify extension is the most updated version.
    • Go to Apps > Sezzle, then click About. If there is an option to upgrade, do so now.
  • Sezzle gateway is activated.
    • Go to Settings > Payment Providers and ensure "Sezzle is active" is listed under the Alternative Payment Methods section.
  • 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.
  • 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.

Manual Theme Integration

If the Shopify 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 Sales Channels > Online Store > Themes.
  2. Click Actions, then select Edit Code.
  3. In the Code Explorer, go to the Templates folder and select the product.liquid file.
  4. Copy+paste the script to the very bottom of the file, then click Save.
  5. Repeat the previous step in the cart.liquid file.

Note: If you have additional custom product templates, step 4 will need to be repeated for each file, or the script added to a global file, such as layout/theme.liquid.

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>
Update {sezzle_merchant_uuid} in the above script template with your site’s Merchant ID (removing the curly brackets), which can be found in the Sezzle Merchant Dashboard.

Example:

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

For assistance with widget configuration, click Request Addition of Widgets in the widget step of your Sezzle Merchant Dashboard Setup Checklist.

Uninstall Steps

  1. Go to Apps.
  2. Under Sezzle, click Delete.
  3. Go to Settings > Payment Providers.
  4. Under Alternative Payment Methods, find Sezzle and click Edit.
  5. Click Deactivate Sezzle.
  6. Click Deactivate Sezzle to confirm.

Inventory Locking

Our Shopify integration has an optional feature to prevent overselling while a customer is checking out with Sezzle. To enable this feature, please reach out to our Merchant Success team at [email protected].

Shopify Sandbox Testing

Sezzle offers an alternate sandbox payment gateway that can be used to test your integration. If you would like to install this gateway for testing, please reach out to our Merchant Success team at [email protected].

WooCommerce

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

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

Integration Steps Overview

  1. Install and configure the Sezzle WooCommerce 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle WooCommerce Extension

  1. Log in to your website's Wordpress admin.
    * Ex: your-website.com/wp-admin
    wordpress loginwordpress login
  2. In the left sidebar, click Plugins > Add New.
  3. Search for Sezzle.
  4. Click Install Now.
    search sezzlesearch sezzle
  5. Click Activate.
    activate sezzleactivate sezzle

Admin Configuration

  1. In the left sidebar, click WooCommerce > Settings .
  2. Select the Payments tab.
    payment settingspayment settings
  3. Click the Manage button for Sezzle.
    select sezzleselect sezzle
  4. Check the Enable/Disable checkbox for enabling Sezzle.
  5. Check the Payment option availability in other countries if you want to allow Sezzle outside of US and Canada.
    • Note, Sezzle operates only in US and Canada. Be sure to check this option.
  6. Set Merchant ID as received from the Business section of Sezzle Merchant Dashboard.
  7. Copy your Private Key and Public Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields.
  8. Set Minimum Checkout Amount if you want to restrict Sezzle based on a minimum order total.
  9. Set the Transaction Mode as Live for production and Sandbox for sandbox testing mode.
  10. Check the Show Sezzle widget in product pages checkbox for adding widget script in the Product Display Page, which allows enabling Sezzle Widget Modal in PDP.
  11. Configure the installment plan widget under Installment Plan Widget Configuration settings
    1. Check the Enable Installment Widget Plan in Checkout page checkbox for enabling installment widget plan.
    2. Set the Order Total Container Class Name. Default is woocommerce-Price-amount.
    3. Set the Order Total Container Parent Class Name. Default is order-total.
  12. Check the Enable Logging checkbox for logging Sezzle checkout related data. This is helpful for debugging issues, if encountered.
    sezzle page overviewsezzle page overview
  13. Click Save Changes.

WooCommerce Sandbox Testing

  1. In the Sezzle configuration page of your WooCommerce admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and set the Transaction Mode to Sandbox, then save the configuration. 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.
    select sezzle paymentselect sezzle payment
  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.

WooCommerce Live Checkout

  1. In the Sezzle configuration page of your WooCommerce admin, enter the API Keys from your Sezzle Merchant Dashboard and set the Transaction Mode to Live, 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.
    select sezzle paymentselect sezzle 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.

Important Note on Order Fulfillment

Before shipping the order, ensure that the Order Notes in the WooCommerce interface show the order status is Processing and include Payment approved by Sezzle. When these notes exist, you know that the customer completed the checkout at Sezzle, and you will be paid for the order.

WooCommerce will create an order regardless of whether the customer completes the checkout at Sezzle. Check the Order Notes and do not fulfill orders where the Sezzle checkout is not completed.

Troubleshooting

If testing was unsuccessful, review the following:

  • Sezzle WooCommerce extension is the most updated version.
    • Go to Plugins > Installed Plugins, then click View Details next to the Sezzle WooCommerce Payment. If there is an option to upgrade, do so now.
  • Sezzle extension is activated.
    • Go to WooCommerce > Settings and ensure the switch is turned On.
  • 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.
  • Show Sezzle widget in product pages box is checked.
  • 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.

Uninstall Steps

  1. Go to Plugins > Installed Plugins.
  2. Under Sezzle WooCommerce Payment, click Deactivate then click Delete.

Zoey

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

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

Integration Steps Overview

  1. Install and configure the Sezzle Zoey 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.
  3. Familiarize yourself with the transaction flow when buying with Sezzle.

Install the Sezzle Zoey Extension

Go to https://www.zoey.com/apps/sezzle/ and click Get App.

Admin Configuration

  1. Go to Set-up > Payment Methods > Sezzle.
  2. Click Configure.
    admin zoeyadmin zoey
  3. Configure the extension as follows:
    1. Set Enabled to Yes.
    2. Copy your Merchant ID from your Sezzle Merchant Dashboard, and paste it into the corresponding field in the Sezzle configuration page of your Zoey admin.
    3. Copy your Public Key and Private Key from your Sezzle Merchant Dashboard, and paste them into the corresponding fields in the Sezzle configuration page of your Zoey admin.
    4. If you want the widget script added to the Product Display Page, set Add Widget Script in PDP to Yes
    5. If you want the widget script added to the Cart Page, set Add Widget Script in Cart Page to Yes
    6. Set Payment from Applicable Countries to Specific Countries.
    7. Set Payment from Specific Countries to United States or Canada as applicable.
    8. Save the configuration.
      admin zoey sezzlepayadmin zoey sezzlepay
  4. Click Advanced/Refresh Your Store.
  5. Installation is complete.

Zoey Sandbox Testing

  1. In the Sezzle configuration page of your Zoey admin, enter the Sandbox API Keys from your Sezzle Merchant Sandbox Dashboard and set the API Mode to Sandbox/Test, then save the configuration. 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 Continue then Place Order and you should be redirected to the Sezzle checkout page. If prompted, sign in.
    onepage zoey payment movementonepage zoey payment movement
  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.

Zoey Live Checkout

  1. In the Sezzle configuration page of your Zoey admin, enter the API Keys from your Sezzle Merchant Dashboard and set the API Mode to Live, then save the configuration.
  2. On your website, add an item to your cart, then proceed to Checkout and select Sezzle as the payment method.
  3. Click Continue then Place Order.
    onepage zoey payment movementonepage zoey payment movement
  4. If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
    sezzle checkoutsezzle checkout
  5. Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete.