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.

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

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

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.

Integration Flow

Overview of Integration 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

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.

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": "john.doe@sezzle.com",
        "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​

Customer Details Object​

Address Object​

This is used for both billing and shipping

Item Object​

Tax Amount Object​

Shipping Amount Object​

Discount Object​

Price Object​

Metadata Object​

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

Notification Object​

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

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": "john.doe@sezzle.com",
        "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)​

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​

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

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

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​

Order Update Events/Types​

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​

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.

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.