Sezzle

https://docs.sezzle.com/
Admin
Sezzle is a buy-now-pay-later payment platform that enables merchants to accept flexible installment...
Tokens:127,868
Snippets:1,180
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize Checkout with Payload

Source: https://docs.sezzle.com/docs/guides/direct/integration

Use these examples to start a checkout session by providing the order details directly. The template shows the required structure, while the example provides populated values.

```javascript
checkoutSdk.startCheckout({
  checkout_payload: {
    order: {
      intent: string,
      reference_id: string,
      description: string,
      order_amount: {
        amount_in_cents: integer,
        currency: string,
      },
    },
  },
});
```

```javascript
checkoutSdk.startCheckout({
  checkout_payload: {
    order: {
      intent: "AUTH",
      reference_id: "543645yg5tg5675686",
      description: "sezzle-store - #12749253509255",
      order_amount: {
        amount_in_cents: 10000,
        currency: "USD",
      },
    },
  },
});
```

--------------------------------

### Initialize Sezzle Installment Widget (Shopify Example)

Source: https://docs.sezzle.com/docs/guides/widgets/checkout-installments

Example of initializing the SezzleInstallmentWidget for Shopify. The `platform` option is set to 'shopify'. The `checkoutTotalElemTargetPath` is commented out, indicating it might be auto-detected or not needed for this configuration.

```html
<div id="sezzle-installment-widget-box"></div>
<script type='text/javascript'>
    new SezzleInstallmentWidget({
        'platform': 'shopify',
        // 'checkoutTotalElemTargetPath': '.payment-due__price'
    });
</script>
```

--------------------------------

### Full Checkout Implementation Example

Source: https://docs.sezzle.com/llms-full.txt

Comprehensive example showing payload configuration and payment capture logic within the event handlers.

```javascript
checkoutSdk.init({
  onClick: function () {
    event.preventDefault();
    checkoutSdk.startCheckout({
      checkout_payload: {
        order: {
          intent: "AUTH",
          reference_id: "543645yg5tg5675686",
          description: "sezzle-store - #12749253509255",
          order_amount: {
            amount_in_cents: 10000,
            currency: "USD",
          },
        },
      },
    });
  },
  onComplete: function (response) {
    alert("Completed transaction. Capture started.");
    checkoutSdk
    .capturePayment(response.data.order_uuid, {
        capture_amount: {
        amount_in_cents: 10000,
        currency: "USD",
        },
        partial_capture: false,
    })
    .then((r) => {
        console.log(r);
    });
  },
  onCancel: function () {
    console.log("Checkout cancelled.");
  },
  onFailure: function () {
    console.log("Checkout failed.");
  },
});
```

--------------------------------

### AwesomeSezzle Implementation Example

Source: https://docs.sezzle.com/llms-full.txt

A practical implementation example using Shopify Liquid variables for the amount and specific styling configurations.

```html
<script>
    var renderSezzle = new AwesomeSezzle({
        amount: "{{ product.selected_or_first_available_variant.price | money }}",
        renderElement: "new-sezzle-widget-container-id",
        numberOfPayments: 5,
        theme: "light",
        modalTheme: "color",
        maxWidth: 400,
        marginTop: 0,
        marginBottom: 0,
        marginLeft: 0,
        marginRight: 0,
        alignment: "left",
        alignmentSwitchMinWidth: 576,
        alignmentSwitchType: "center",
        textColor: "#111",
        fontFamily: "Comfortaa, sans-serif",
        fontSize: 12,
        fontWeight: 400,
        widgetType: "product-page",
        fixedHeight: 0,
        logoSize: 1.0,
        logoStyle: {},
        language: "en",
        parseMode: "default",
        merchantLocale: "North America",
        ineligibleWidgetTemplate:
            "%%logo%% Pay in 4 interest-free payments on purchases $35-$2,500. %%info%%",
        minPrice: 3500, // Amount in cents
        maxPrice: 250000, // Amount in cents
    });
    renderSezzle.init();
</script>
```

--------------------------------

### Sezzle Widget Example Configuration

Source: https://docs.sezzle.com/docs/guides/widgets/static

An example demonstrating how to configure the AwesomeSezzle widget with specific values for various options, including amount, theme, and layout settings.

```javascript
var renderSezzle = new AwesomeSezzle({
            amount: "{{ product.selected_or_first_available_variant.price | money }}",
            renderElement: "new-sezzle-widget-container-id",
            numberOfPayments: 5,
            theme: "light",
            modalTheme: "color",
            maxWidth: 400,
            marginTop: 0,
            marginBottom: 0,
            marginLeft: 0,
            marginRight: 0,
            alignment: "left",
            alignmentSwitchMinWidth: 576,
            alignmentSwitchType: "center",
            textColor: "#111",
            fontFamily: "Comfortaa, sans-serif",
            fontSize: 12,
            fontWeight: 400,
            widgetType: "product-page",
            fixedHeight: 0,
            logoSize: 1.0,
            logoStyle: {},
            language: "en",
            parseMode: "default",
            merchantLocale: "North America",
            ineligibleWidgetTemplate:
                "%%logo%% Pay in 4 interest-free payments on purchases $35-$2,500. %%info%%",
            minPrice: 3500, // Amount in cents
            maxPrice: 250000, // Amount in cents
        });
        renderSezzle.init();
```

--------------------------------

### Authentication Response Example

Source: https://docs.sezzle.com/docs/api/core/authentication/postauthentication

Example JSON response upon successful authentication.

```json
{
  "expiration_date": "2017-01-01T01:30:25.388Z",
  "merchant_uuid": "merchant1234567890",
  "token": "example-token"
}
```

--------------------------------

### NotFound Error Response Example

Source: https://docs.sezzle.com/docs/api/core/orders/patchv2updatecheckoutbyorder

Example JSON structure for a resource not found error.

```json
[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]
```

--------------------------------

### Sezzle Banner Initialization (Example)

Source: https://docs.sezzle.com/docs/guides/home-banner

An example of the Sezzle banner initialization with placeholder values for theme and merchant UUID. This demonstrates how to configure the banner for a specific merchant and theme.

```html
<script src="YOUR_FILE_PATH_HERE.js"></script>
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    theme: "indigo",
    renderToContainer: "#sezzle-banner-render-reference",
}).init();
</script>
```

--------------------------------

### Sezzle Installment Widget Implementation

Source: https://docs.sezzle.com/llms-full.txt

Use these snippets to initialize the Sezzle widget. Choose between a template for dynamic platform configuration or a concrete example for Shopify.

```html
<div id="sezzle-installment-widget-box"></div>
<script type='text/javascript'>
    new SezzleInstallmentWidget({
        'platform': `${yourPlatformIfSupported}`,
        'checkoutTotalElemTargetPath': `${yourPriceElementXPath}`
    });
</script>
```

```html
<div id="sezzle-installment-widget-box"></div>
<script type='text/javascript'>
    new SezzleInstallmentWidget({
        'platform': 'shopify',
        // 'checkoutTotalElemTargetPath': '.payment-due__price'
    });
</script>
```

--------------------------------

### CDN Integration: Example Snippet

Source: https://docs.sezzle.com/docs/guides/home-banner

An example of the CDN integration snippet, pre-filled with a sample merchant UUID and theme. This shows a typical configuration for immediate use.

```html
<script src="https://checkout-sdk.sezzle.com/sezzle-home-banner.min.js"></script>
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    theme: "indigo",
    renderToContainer: "#sezzle-banner-render-reference",
}).init();
</script>
```

--------------------------------

### Authentication Request Example

Source: https://docs.sezzle.com/docs/api/core/authentication/postauthentication

Example JSON payload for the authentication request.

```json
{
  "private_key": "sz_pr_...",
  "public_key": "sz_pub_..."
}
```

--------------------------------

### Install Sezzle SDK via CocoaPods

Source: https://docs.sezzle.com/docs/guides/mobile/ios

Add the dependency to your Podfile and install.

```ruby
pod 'SezzleMerchantSDK'
```

```bash
pod install
```

--------------------------------

### Initialize Checkout with URL

Source: https://docs.sezzle.com/docs/guides/direct/integration

Start the checkout process by providing a direct checkout URL.

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

--------------------------------

### Sezzle Configuration Example

Source: https://docs.sezzle.com/llms-full.txt

A practical implementation of the Sezzle configuration, demonstrating specific styling, price element filtering, and event observation.

```html
<script type="text/javascript">
    document.sezzleConfig = {
      configGroups: [
        {
          "targetXPath": ".price",
          "renderToPath": "..",
          "urlMatch": "product",
          "theme": "auto",
          "ignoredPriceElements": ["DEL","STRIKE"],
          "ignoredFormattedPriceText": ["Subtotal", "Total:", "Sold Out"],
          "alignment": "inherit",
          "alignmentSwitchMinWidth": 0,
          "alignmentSwitchType": "inherit",
          "containerStyle": {
            "marginTop": "0px",
            "marginBottom": "0px",
            "marginRight": "0px",
            "marginLeft": "0px"
          },
          "textStyle": {
            "color": "inherit",
            "fontFamily": "inherit",
            "fontSize": "14px",
            "fontWeight": 500,
            "lineHeight": "13px",
            "maxWidth": "480px"
          },
          "logoStyle": {
            "transform": "scale(1)",
            "transformOrigin": "center",
            "margin": "0px"
          },
          "hideClasses": [],
          "relatedElementActions": [{
            "relatedPath": "..",
            "initialAction": function(r,w){
              if(r.className.indexOf('compare') > -1){
                w.style.display = "none"
              }
            }
          }]
        }
      ],
      "language": document.querySelector("html").lang || "en",
      "apDualInstall": false,
      "klarnaDualInstall": false,
      "minPrice": 0,
      "maxPrice": 250000,
      "observeElements": [
        {
          "eventType": "click",
          "element": ".options-selector"
        }
      ]
    }
</script>
```

--------------------------------

### Shopify Local File Integration: Example Snippet

Source: https://docs.sezzle.com/docs/guides/home-banner

An example of the template snippet with placeholder values for merchantUUID, theme, and renderToContainer. This demonstrates how to configure the banner for a specific theme and rendering target.

```html
{{ "sezzle-home-banner.js" | asset_url | script_tag }}
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    theme: "indigo",
    renderToContainer: "#sezzle-banner-render-reference",
}).init();
</script>
```

--------------------------------

### Install Sezzle Static Widget via NPM

Source: https://docs.sezzle.com/docs/guides/widgets/static

Install the Sezzle static widget package using npm. This is the first step for integrating the widget into your project.

```bash
npm install @sezzle/sezzle-static-widget@latest
```

--------------------------------

### Import Sezzle Installment Widget (NPM)

Source: https://docs.sezzle.com/docs/guides/widgets/checkout-installments

Import the Sezzle installment widget library when using the NPM package manager.

```html
import SezzleInstallmentWidget from @sezzle/sezzle-installment-widget
```

--------------------------------

### Initialize Sezzle Checkout

Source: https://docs.sezzle.com/docs/guides/virtual/automated

Use these examples to structure the checkout payload when calling the startCheckout method.

```javascript
checkoutSdk.startCheckout({
  checkout_payload: {
    amount_in_cents: integer,
    currency: string,
    merchant_reference_id: string,
    customer: {
        email: string,
        first_name: string,
        last_name: string,
        phone: string,
        billing_address_street1: string,
        billing_address_street2: string,
        billing_address_city: string,
        billing_address_state: string,
        billing_address_postal_code: string,
        billing_address_country_code: string,
    },
    items: [
        {
            name: string,
            sku: string,
            quantity: integer,
            price: {
                amount_in_cents: integer,
                currency: string,
            },
        },
    ],
  },
});
```

```javascript
checkoutSdk.startCheckout({
  checkout_payload: {
    amount_in_cents: 1000,
    currency: "USD",
    merchant_reference_id: "merchant-checkout-id-max-255",
    customer: {
        email: "test@test.com",
        first_name: "John",
        last_name: "Doe",
        phone: "0987654321",
        billing_address_street1: "3432 Terry Lane",
        billing_address_street2: "12",
        billing_address_city: "Katy",
        billing_address_state: "TX",
        billing_address_postal_code: "77449",
        billing_address_country_code: "US",
    },
    items: [
        {
            name: "Blue tee",
            sku: "sku123456",
            quantity: 1,
            price: {
                amount_in_cents: 1000,
                currency: "USD",
            },
        },
    ],
  },
});
```

--------------------------------

### Retrieve Installment Plan

Source: https://docs.sezzle.com/docs/guides/direct/integration

Initialize a checkout instance to fetch installment plan details based on a total amount in cents.

```javascript
const checkout = new Checkout({});
checkout.getInstallmentPlan(1000);
```

--------------------------------

### Dispute Webhook Example

Source: https://docs.sezzle.com/docs/api/core/webhooks/infov2webhooks

This example covers various dispute-related webhooks, including requests for merchant input, approaching deadlines, and closure statuses (customer win, merchant win, neutral). It provides details about the dispute, order, and customer.

```json
{
    "uuid": "79f1e9cd-f1ef-42fa-b7b4-2ed8d9e9fae8",
    "created_at": "2025-04-11T17:22:22.717757Z",
    "event": "dispute.merchant_input_requested",
    "data_type": "dispute",
    "data": {
        "customer_name": "John Doe",
        "order_uuid": "e17280f3-d575-4bc2-99ff-ff881df7b137",
        "order_reference_id": "order-reference-id-123",
        "sezzle_order_id": "d2s7t-281qj-rf6ra-dqfcg",
        "order_date": "2024-08-20",
        "dispute_type": "No Product Or Service",
        "dispute_due_date": "2025-04-08",
        "dispute_id": 132,
        "dispute_amount_in_cents": 2500,
        "dispute_currency": "USD",
        "dispute_status": "Closed All Win"
    }
}
```

--------------------------------

### checkout.getInstallmentPlan(totalInCents)

Source: https://docs.sezzle.com/docs/guides/direct/integration

Retrieves the installment plan details for a given total amount in cents.

```APIDOC
## checkout.getInstallmentPlan(totalInCents)

### Description
Calculates and returns the installment schedule based on the provided total order amount.

### Parameters
- **totalInCents** (integer) - Required - The total order amount in cents.

### Response
- **schedule** (string) - The payment cadence (e.g., "bi-weekly").
- **totalInCents** (integer) - The total amount in cents.
- **installments** (array) - A list of individual installment objects.
  - **installment** (integer) - The sequence number of the installment.
  - **amountInCents** (integer) - The amount due for this installment.
  - **dueDate** (string) - The date the installment is due.
```

--------------------------------

### Start a Checkout with Javascript SDK

Source: https://docs.sezzle.com/llms-full.txt

Initiates a checkout session by passing the required payload including amount, currency, and order reference.

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

--------------------------------

### Install Sezzle SDK via Swift Package Manager

Source: https://docs.sezzle.com/docs/guides/mobile/ios

Add the repository URL as a package dependency in Xcode.

```text
https://github.com/sezzle/sezzle-merchant-sdk-ios.git
```

--------------------------------

### Configure Checkout object

Source: https://docs.sezzle.com/docs/guides/direct/integration

Initialize the Checkout object with required parameters. Use the template for structure and the example for a concrete implementation.

```javascript
const checkoutSdk = new Checkout({
  mode: string,
  publicKey: string,
  apiMode: string,
  apiVersion: string,
});
```

```javascript
const checkoutSdk = new Checkout({
  mode: "popup",
  publicKey: "sz_pub_...",
  apiMode: "sandbox",
  apiVersion: "v2",
});
```

--------------------------------

### GET /v2/settlements/summaries

Source: https://docs.sezzle.com/llms-full.txt

Retrieves a summarized list of settlement payouts.

```APIDOC
## GET /v2/settlements/summaries

### Description
Get a summarized list of settlement payouts. If no currency is provided, the default is USD.

### Method
GET

### Endpoint
/v2/settlements/summaries
```

--------------------------------

### GET /v2/webhooks

Source: https://docs.sezzle.com/llms-full.txt

Lists all webhook subscriptions associated with the account.

```APIDOC
## GET /v2/webhooks

### Description
Get a list of webhooks you are subscribed to.

### Method
GET

### Endpoint
/v2/webhooks
```

--------------------------------

### OpenAPI Specification for Get Webhook

Source: https://docs.sezzle.com/docs/api/core/webhooks/getv2webhook

The OpenAPI definition for the Get Webhook endpoint, including request parameters, response schemas, and example payloads for various status codes.

```yaml
openapi: 3.1.0
info:
  title: Sezzle API v2
  description: >-
    This Sezzle API is for merchants who want to accept Sezzle as a payment
    option
  termsOfService: https://legal.sezzle.com
  version: 2.0.0
  x-logo:
    url: https://media.sezzle.com/branding/2.0/png/Logo_WhiteWordmark_500x126.png
    backgroundColor: '#392558'
servers:
  - url: https://sandbox.gateway.sezzle.com
    description: development server, usa, ca
  - url: https://gateway.sezzle.com
    description: production server, usa, ca
security:
  - Bearer: []
externalDocs:
  description: Sezzle API guides and tutorials
  url: https://docs.sezzle.com/sezzle-integration
paths:
  /v2/webhooks/{webhooks_uuid}:
    get:
      tags:
        - Webhooks
      summary: Get webhook
      description: Get a single webhook you are subscribed to by its UUID
      operationId: HandleGetWebhook
      parameters:
        - name: webhooks_uuid
          in: path
          description: The webhook UUID to retrieve
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
              example:
                uuid: 747cf28a-bb5c-46a8-a288-d9b006fd6113
                links:
                  - href: https://sandbox.gateway.sezzle.com/v2/webhooks
                    rel: create
                    method: POST
                  - href: https://sandbox.gateway.sezzle.com/v2/webhooks
                    rel: list
                    method: GET
                  - href: >-
                      https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                    rel: self
                    method: GET
                  - href: >-
                      https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                    rel: self
                    method: PATCH
                  - href: >-
                      https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                    rel: self
                    method: DELETE
                url: https://example.com/webhooks
                events:
                  - customer.tokenized
        '400':
          $ref: '#/components/responses/BadRequestV2'
          example:
            code: bad_request
            message: bad request
        '401':
          $ref: '#/components/responses/UnauthorizedV2'
          example:
            code: unauthorized
            message: authorization not accepted
        '404':
          $ref: '#/components/responses/NotFoundV2'
          example:
            code: record_not_found
            message: webhook not found
        '422':
          $ref: '#/components/responses/UnprocessableV2'
          example:
            code: invalid
            message: UnprocessableV2 entity
components:
  schemas:
    WebhookResponse:
      allOf:
        - $ref: '#/components/schemas/Response'
        - $ref: '#/components/schemas/Webhook'
    Response:
      type: object
      properties:
        uuid:
          type: string
          description: The unique identifier for this response
        links:
          type: array
          description: Available API links prefilled with UUID with accompanying method
          items:
            $ref: '#/components/schemas/Link'
    Webhook:
      type: object
      properties:
        url:
          type: string
          description: The URL you are using to receive webhooks
        events:
          type: array
          description: An array of webhook events you wish to subscribe to
          items:
            $ref: '#/components/schemas/WebhookEvents'
      required:
        - url
        - events
    ErrorV2:
      type: object
      properties:
        code:
          type: string
          description: The general error type
        message:
          type: string
          description: A more specific error message, if available
        location:
          type: string
          description: Where the error occurred
        debug_uuid:
          type: string
          description: The unique identifier assigned to this error for troubleshooting
    Link:
      type: object
      required:
        - href
      properties:
        href:
          type: string
```

--------------------------------

### SezzlePromotionalView Initialization

Source: https://docs.sezzle.com/docs/guides/mobile/ios

Initializes a new promotional widget view to display installment pricing on a product page.

```APIDOC
## SezzlePromotionalView(amountInCents:currency:style:widgetConfig:presentingFrom:)

### Description
Creates a view that displays Sezzle installment pricing. The widget automatically updates based on the provided price.

### Parameters
- **amountInCents** (Int) - Required - Product price in cents.
- **currency** (String) - Optional - ISO 4217 currency code (default: "USD").
- **style** (SezzlePromotionalStyle) - Optional - Visual style, .light or .dark (default: .light).
- **widgetConfig** (SezzleWidgetConfig) - Optional - Configuration for pricing thresholds.
- **presentingFrom** (UIViewController) - Required - The view controller used to present the info modal.
```

--------------------------------

### Preapprove Amount Request Example

Source: https://docs.sezzle.com/docs/api/tokenization/customers/preapprovev2token

JSON payload for verifying preapproval for a specific amount.

```json
amount_in_cents: 5000
currency: USD
```

--------------------------------

### Preapprove Amount Response Example

Source: https://docs.sezzle.com/docs/api/tokenization/customers/preapprovev2token

Successful response indicating the approval status of the shopper.

```json
uuid: 6c9db5d4-d09a-4224-860a-b5438ac32ca8
approved: true
```

--------------------------------

### OpenAPI Specification for List Webhooks

Source: https://docs.sezzle.com/docs/api/core/webhooks/getv2webhooks

The OpenAPI definition for the GET /v2/webhooks endpoint, including request/response schemas and error examples.

```yaml
openapi: 3.1.0
info:
  title: Sezzle API v2
  description: >-
    This Sezzle API is for merchants who want to accept Sezzle as a payment
    option
  termsOfService: https://legal.sezzle.com
  version: 2.0.0
  x-logo:
    url: https://media.sezzle.com/branding/2.0/png/Logo_WhiteWordmark_500x126.png
    backgroundColor: '#392558'
servers:
  - url: https://sandbox.gateway.sezzle.com
    description: development server, usa, ca
  - url: https://gateway.sezzle.com
    description: production server, usa, ca
security:
  - Bearer: []
externalDocs:
  description: Sezzle API guides and tutorials
  url: https://docs.sezzle.com/sezzle-integration
paths:
  /v2/webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: Get a list of webhooks you are subscribed to
      operationId: HandleListWebhooks
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookResponse'
                example:
                  - uuid: 747cf28a-bb5c-46a8-a288-d9b006fd6113
                    links:
                      - href: https://sandbox.gateway.sezzle.com/v2/webhooks
                        rel: create
                        method: POST
                      - href: https://sandbox.gateway.sezzle.com/v2/webhooks
                        rel: list
                        method: GET
                      - href: >-
                          https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                        rel: self
                        method: GET
                      - href: >-
                          https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                        rel: self
                        method: PATCH
                      - href: >-
                          https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113
                        rel: self
                        method: DELETE
                    url: https://example.com/webhooks
                    events:
                      - customer.tokenized
        '400':
          $ref: '#/components/responses/BadRequestV2'
          example:
            code: bad_request
            message: bad request
        '401':
          $ref: '#/components/responses/UnauthorizedV2'
          example:
            code: unauthorized
            message: authorization not accepted
        '404':
          $ref: '#/components/responses/NotFoundV2'
          example:
            code: record_not_found
            message: not found
        '422':
          $ref: '#/components/responses/UnprocessableV2'
          example:
            code: invalid
            message: UnprocessableV2 entity
components:
  schemas:
    WebhookResponse:
      allOf:
        - $ref: '#/components/schemas/Response'
        - $ref: '#/components/schemas/Webhook'
    Response:
      type: object
      properties:
        uuid:
          type: string
          description: The unique identifier for this response
        links:
          type: array
          description: Available API links prefilled with UUID with accompanying method
          items:
            $ref: '#/components/schemas/Link'
    Webhook:
      type: object
      properties:
        url:
          type: string
          description: The URL you are using to receive webhooks
        events:
          type: array
          description: An array of webhook events you wish to subscribe to
          items:
            $ref: '#/components/schemas/WebhookEvents'
      required:
        - url
        - events
    ErrorV2:
      type: object
      properties:
        code:
          type: string
          description: The general error type
        message:
          type: string
          description: A more specific error message, if available
        location:
          type: string
          description: Where the error occurred
        debug_uuid:
          type: string
          description: The unique identifier assigned to this error for troubleshooting
    Link:
      type: object
      required:
        - href
      properties:
        href:
          type: string
          description: The fully qualified URL for the API endpoint
        rel:
          type: string
          description: >-
            The relationship type indicating the purpose of this link (e.g.,
            'self' for the current resource, 'create' for creating a new
            resource, 'list' for listing resources)
          enum:
            - self
            - capture
            - checkout
            - create
            - customer
            - list
            - order
            - preapprove
            - refund
            - release
            - session
```

--------------------------------

### Initialize Sezzle Installment Widget (Template)

Source: https://docs.sezzle.com/docs/guides/widgets/checkout-installments

This is a template for initializing the SezzleInstallmentWidget. Provide your platform or a target path for the checkout total element.

```html
<div id="sezzle-installment-widget-box"></div>
<script type='text/javascript'>
    new SezzleInstallmentWidget({
        'platform': `${yourPlatformIfSupported}`,
        'checkoutTotalElemTargetPath': `${yourPriceElementXPath}`
    });
</script>
```

--------------------------------

### GET /v1/orders/{order_reference_id}

Source: https://docs.sezzle.com/llms-full.txt

Retrieves details and status for a specific order.

```APIDOC
## GET /v1/orders/{order_reference_id}

### Description
Get details and check the status of an existing order.

### Method
GET

### Endpoint
/v1/orders/{order_reference_id}

### Parameters
#### Path Parameters
- **order_reference_id** (string) - Required - The unique identifier for the order.
```

--------------------------------

### Initialize Sezzle Checkout SDK

Source: https://docs.sezzle.com/docs/guides/express/express-checkout

Configure the SDK instance with your public key and environment settings. Use the template for structure and the example for a concrete implementation.

```javascript
const checkoutSdk = new Checkout({
  mode: string,
  publicKey: string,
  apiMode: string,
  apiVersion: string,
});
```

```javascript
const checkoutSdk = new Checkout({
  mode: "popup",
  publicKey: "sz_pub_...",
  apiMode: "live",
  apiVersion: "v2",
});
```

--------------------------------

### GET /v2/session/{session_uuid}

Source: https://docs.sezzle.com/llms-full.txt

Retrieve details for a specific Sezzle session.

```APIDOC
## GET /v2/session/{session_uuid}

### Description
Get session details.

### Method
GET

### Endpoint
/v2/session/{session_uuid}

### Parameters
#### Path Parameters
- **session_uuid** (string) - Required - The unique identifier of the session.
```

--------------------------------

### GET /v1/interest/activity

Source: https://docs.sezzle.com/llms-full.txt

Retrieves the current activity on the interest account for enrolled users.

```APIDOC
## GET /v1/interest/activity

### Description
If you are enrolled in the interest account program, get the current activity on the interest account.

### Method
GET

### Endpoint
/v1/interest/activity
```

--------------------------------

### Installment Plan Response Structure

Source: https://docs.sezzle.com/docs/guides/direct/integration

The installment plan response provides the payment schedule and a breakdown of individual installment amounts and due dates.

```json
{
    "schedule": string,
    "totalInCents": integer,
    "installments": [
        {
            "installment": integer,
            "amountInCents": integer,
            "dueDate": string
        }
    ]
}
```

```json
{
    "schedule": "bi-weekly",
    "totalInCents": 1000,
    "installments": [
        {
            "installment": 1,
            "amountInCents": 250,
            "dueDate": "2020-10-14"
        },
        {
            "installment": 2,
            "amountInCents": 250,
            "dueDate": "2020-10-28"
        },
        {
            "installment": 3,
            "amountInCents": 250,
            "dueDate": "2020-11-11"
        },
        {
            "installment": 4,
            "amountInCents": 250,
            "dueDate": "2020-11-25"
        }
    ]
}
```

--------------------------------

### GET /v2/settlements/details/{payout_uuid}

Source: https://docs.sezzle.com/llms-full.txt

Retrieves details for a specific settlement payout.

```APIDOC
## GET /v2/settlements/details/{payout_uuid}

### Description
Get details on a specific settlement payout.

### Method
GET

### Endpoint
/v2/settlements/details/{payout_uuid}

### Parameters
#### Path Parameters
- **payout_uuid** (string) - Required - The unique identifier for the payout.
```

--------------------------------

### GET /v2/interest/activity

Source: https://docs.sezzle.com/llms-full.txt

Retrieve current activity on the interest account for enrolled merchants.

```APIDOC
## GET /v2/interest/activity

### Description
If you are enrolled in the interest account program, get the current activity on the interest account.

### Method
GET

### Endpoint
/v2/interest/activity
```

--------------------------------

### checkout.init(options)

Source: https://docs.sezzle.com/docs/guides/direct/integration

Initializes the SDK with event handlers for checkout completion and failure.

```APIDOC
## checkout.init(options)

### Description
Configures the SDK with callback functions to handle checkout lifecycle events.

### Parameters
- **onComplete** (function) - Optional - Callback triggered when the checkout is successfully completed.
- **onFailure** (function) - Optional - Callback triggered when the checkout fails to load or encounters an error.
```

--------------------------------

### GET /v1/settlements/summaries

Source: https://docs.sezzle.com/llms-full.txt

Retrieves a summarized list of settlement payouts for the merchant account.

```APIDOC
## GET /v1/settlements/summaries

### Description
Get a summarized list of settlement payouts.

### Method
GET

### Endpoint
/v1/settlements/summaries
```

--------------------------------

### GET /v1/interest/balance

Source: https://docs.sezzle.com/llms-full.txt

Retrieves the current balance of an interest account for enrolled users.

```APIDOC
## GET /v1/interest/balance

### Description
If you are enrolled in the interest account program, get the current balance on the interest account. Fractions of cents are tracked to properly calculate daily interest accrual even if the interest balance is low.

### Method
GET

### Endpoint
/v1/interest/balance
```

--------------------------------

### Initialize SezzlePromotionalView

Source: https://docs.sezzle.com/llms-full.txt

Add the promotional widget to a product screen by providing the context and price in cents.

```kotlin
import com.sezzle.sdk.SezzlePromotionalView

val promoView = SezzlePromotionalView(
    context = this,
    amountInCents = 9999  // $99.99
)
promoView.setPresenter(this)  // Activity for modal presentation
container.addView(promoView)
```

--------------------------------

### BadRequestV2 Error Example

Source: https://docs.sezzle.com/docs/api/core/orders/postv2upchargebyorder

Example of a 400 Bad Request error response.

```json
[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]
```

--------------------------------

### Error Response Examples

Source: https://docs.sezzle.com/docs/api/core/authentication/postauthentication

Examples of various error responses returned by the API.

```json
{
  "code": "bad_request",
  "message": "missing public_key"
}
```

```json
{
  "code": "unauthorized",
  "message": "authorization not accepted"
}
```

```json
{
  "code": "record_not_found",
  "message": "not found"
}
```

```json
{
  "code": "invalid",
  "message": "UnprocessableV2 entity"
}
```

```json
[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]
```

```json
[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]
```

```json
[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]
```

```json
[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]
```

--------------------------------

### checkout.startCheckout(url)

Source: https://docs.sezzle.com/docs/guides/direct/integration

Initiates the checkout process using an existing checkout URL.

```APIDOC
## checkout.startCheckout(url)

### Description
Starts the Sezzle checkout flow using a pre-generated checkout URL.

### Parameters
- **checkout_url** (string) - Required - The URL provided by the Sezzle checkout session.
```

--------------------------------

### SezzleInstallmentWidget Constructor

Source: https://docs.sezzle.com/llms-full.txt

Initializes the Sezzle installment widget on the page. Requires either a platform identifier or a target path for the checkout total element.

```APIDOC
## SezzleInstallmentWidget(options)

### Description
Initializes the Sezzle installment widget. This constructor should be called after the widget container div is present in the DOM.

### Parameters
- **platform** (string) - Optional - The ecommerce platform hosting the checkout page. Supported: shopify, woocommerce, 3dcart, commentsold, magento2, prestashop, shopware, opencart.
- **checkoutTotalElemTargetPath** (string) - Optional - The ID or class name of the element containing the total order amount.
- **currencySymbol** (string) - Optional - The currency symbol to display. Defaults to the symbol found in the target element or '$'.

### Usage Example
```javascript
new SezzleInstallmentWidget({
    'platform': 'shopify'
});
```
```

--------------------------------

### Order V2 Data Structure

Source: https://docs.sezzle.com/docs/api/core/orders/getv2order

Example of the order object structure including upcharges, dispute details, customer information, and authorization status.

```yaml
is_upcharge: false
upcharges:
  - uuid: 9f8e7d6c-5b4a-3210-9876-54321fedcba0
    amount:
      amount_in_cents: 500
      currency: USD
dispute:
  id: 42
  type: No Product Or Service
  status: Awaiting Merchant Response
  amount:
    amount_in_cents: 10000
    currency: USD
  opened_at: '2026-06-16T14:03:22Z'
  due_date: '2026-06-20'
customer:
  email: john.doe@sezzle.com
  first_name: John
  last_name: Doe
  phone: '5555045294'
  billing_address:
    name: John Doe
    street: 123 Queen Street West
    street2: Unit 104
    city: Toronto
    state: 'ON'
    postal_code: M5H 2M9
    country_code: CA
    phone: '5555045294'
  shipping_address:
    name: John Doe,
    street: 123 Queen Street West,
    street2: Unit 104,
    city: Toronto,
    state: ON,
    postal_code: M5H 2M9
    country_code: CA
    phone: '5555045294'
authorization:
  authorization_amount:
    amount_in_cents: 10000
    currency: USD
  authorization_amount_in_user_currency:
    amount_in_cents: 13700
    currency: CAD
  approved: true
  expiration: '2020-04-23T16:13:44Z'
  financing_option: 4-pay-biweekly
  sezzle_order_id: order-id-in-merchant-dashboard
  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
```

--------------------------------

### Unauthorized Error Response Example

Source: https://docs.sezzle.com/docs/api/core/orders/patchv2updatecheckoutbyorder

Example JSON structure for an unauthorized request error.

```json
[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]
```

--------------------------------

### SezzleSDK.shared.startCheckout

Source: https://docs.sezzle.com/llms-full.txt

Initiates the checkout process using a specific mode, such as .webView to keep the user within the application.

```APIDOC
## SezzleSDK.shared.startCheckout

### Description
Starts the Sezzle checkout process. By setting the mode to .webView, the checkout occurs within the app's WebView instead of the system browser.

### Method
Swift Method

### Signature
SezzleSDK.shared.startCheckout(checkout, from: self, delegate: self, mode: .webView)
```

--------------------------------

### SezzleSDK.startCheckout

Source: https://docs.sezzle.com/llms-full.txt

Initiates the Sezzle checkout process using a listener-based approach. This method is recommended for the default SYSTEM_BROWSER mode.

```APIDOC
## SezzleSDK.startCheckout

### Description
Starts the Sezzle checkout flow. By default, this uses Chrome Custom Tabs, but can be configured to use WebView mode.

### Parameters
- **checkout** (Checkout) - Required - The checkout object containing session details.
- **activity** (Activity) - Required - The current host activity.
- **listener** (CheckoutListener) - Required - Callback for checkout results.
- **mode** (SezzleCheckoutMode) - Optional - The mode to use (e.g., SezzleCheckoutMode.WEB_VIEW).
```

--------------------------------

### Error Response Examples

Source: https://docs.sezzle.com/docs/api/core/webhooks/postv2webhooktest

Examples of error responses returned by the API for various failure scenarios.

```yaml
code: bad_request
message: bad request
```

```yaml
code: unauthorized
message: authorization not accepted
```

```yaml
code: record_not_found
message: not found
```

```yaml
code: invalid
message: UnprocessableV2 entity
```

```yaml
- code: bad_request
  message: bad request
```

```yaml
- code: unauthorized
  message: authorization not accepted
```

```yaml
- code: record_not_found
  message: not found
```

```yaml
- code: invalid
  message: Unprocessable entity
```

--------------------------------

### checkout.startCheckout

Source: https://docs.sezzle.com/llms-full.txt

Initiates the checkout process by providing the checkout payload.

```APIDOC
## checkout.startCheckout

### Description
Initiates the checkout process using the provided checkout payload.

### Parameters
- **checkout_payload** (object) - Required - Contains amount_in_cents, currency_code, order_reference_id, and order_description.
```

--------------------------------

### Webhook Test Request Example

Source: https://docs.sezzle.com/docs/api/core/webhooks/postv2webhooktest

Example JSON payload for triggering a test webhook event.

```yaml
event: order.authorized
url: https://example.com/webhooks
```

--------------------------------

### Install Sezzle Banner via CDN

Source: https://docs.sezzle.com/llms-full.txt

Use these snippets to load the Sezzle banner script directly from the CDN into your Shopify theme.

```html
{{ "//checkout-sdk.sezzle.com/sezzle-home-banner.min.js" | script_tag }}
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "string",
    theme: "string",
    renderToContainer: "string",
}).init();
</script>
```

```html
{{ "//checkout-sdk.sezzle.com/sezzle-home-banner.min.js" | script_tag }}
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    theme: "indigo",
    renderToContainer: "#sezzle-banner-render-reference",
}).init();
</script>
```

--------------------------------

### GET /v1/settlements/details/{payout_uuid}

Source: https://docs.sezzle.com/llms-full.txt

Retrieves detailed information for a specific settlement payout identified by its UUID.

```APIDOC
## GET /v1/settlements/details/{payout_uuid}

### Description
Get details on a specific settlement payout. The response includes a summary of the payout and individual line items that contributed to it.

### Method
GET

### Endpoint
/v1/settlements/details/{payout_uuid}

### Parameters
#### Path Parameters
- **payout_uuid** (string) - Required - The unique identifier for the settlement payout.
```

--------------------------------

### Order Webhook Object Structure

Source: https://docs.sezzle.com/llms-full.txt

The JSON structure for order webhook notifications, including templates and example data.

```json
{
  "time": string,
  "uuid": string,
  "type": string,
  "event": string,
  "object_uuid": string,
  "refund_id": string,
  "refund_amount": {
        "amount_in_cents": number,
        "currency": string
    }
}
```

```json
{
  "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"
    }
}
```

--------------------------------

### Unprocessable Entity Error Response Example

Source: https://docs.sezzle.com/docs/api/core/orders/patchv2updatecheckoutbyorder

Example JSON structure for an unprocessable entity error.

```json
[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]
```

--------------------------------

### Presenting the Checkout Flow in iOS

Source: https://docs.sezzle.com/docs/guides/mobile/ios

Initiate the checkout process using the SDK's startCheckout method. This flow does not require the public key configuration.

```swift
SezzleSDK.shared.startCheckout(
    checkoutURL: URL(string: checkoutURL)!,
    completeURL: URL(string: "yourapp-sezzle://checkout/done")!,
    cancelURL:   URL(string: "yourapp-sezzle://checkout/cancelled")!,
    from: self,
    delegate: self,
    mode: .webView   // or .systemBrowser
)
```

--------------------------------

### Install Sezzle Banner via Local Asset

Source: https://docs.sezzle.com/llms-full.txt

Use these snippets to load the Sezzle banner script from a local asset file uploaded to your Shopify theme.

```html
{{ "sezzle-home-banner.js" | asset_url | script_tag }}
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "string",
    theme: "string",
    renderToContainer: "string",
}).init();
</script>
```

```html
{{ "sezzle-home-banner.js" | asset_url | script_tag }}
<div id="sezzle-banner-render-reference"></div>
<script>
new SezzleBanner({
    merchantUUID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    theme: "indigo",
    renderToContainer: "#sezzle-banner-render-reference",
}).init();
</script>
```

--------------------------------

### Import Sezzle Installment Widget via CDN

Source: https://docs.sezzle.com/llms-full.txt

Include the script tag in your checkout page to load the widget library from the Sezzle CDN.

```html
<script type="text/javascript" defer src="https://checkout-sdk.sezzle.com/installment-widget.min.js"/>
```

--------------------------------

### Example Error Response

Source: https://docs.sezzle.com/docs/api/errors

An example of a specific error response, illustrating how the fields are populated for an invalid order amount.

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