Setting Your Configuration

POST

configuration

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/configuration \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "https://yourdomain.com/webhook"
}
'

{
  "status": 400,
  "id": "bad_request",
  "message": "bad request"
}

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

Webhooks

Order Webhooks

Sezzle handles most of the consumer checkout process on its pages, using webhooks to notify your system about:
- Checkout updates
- Completions
- Refunds
Use the instructions in this page to subscribe to Webhooks
When a webhook event occurs, Sezzle will send the below Webhook object to the URL provided in the configuration

Order Webhook Object

Template
Example
Options

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

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

time

string

The time (UTC) at which the Webhook was generated.

uuid

string

A unique identifier for the webhook.

type

string

The high-level category.Available options: order_update (coming soon)

event

string

The ID for the Checkout/Order.Available options: order_complete, order_refund

object_uuid

string

The ID for the Checkout/Order. For order update webhooks, the object_uuid returned is the reference ID provided during checkout creation by the merchant

refund_id

string

Unique ID for a refund. Included if the webhook event is order_refund

refund_amount

object

Price object. Included if the webhook event is order_refund.

Show child attributes

price

number

The amount in cents

price

number

The 3 character currency code as defined by ISO 4217

Authorizations

Authorization

string

header

required

The authentication token generated from providing API Keys to Sezzle Gateway

Body

application/json

webhook_url

string

required

A URL for us to send our webhooks to

Response

Status No Content

Create a CheckoutInitiate a Sezzle session with shopper order details, redirect links, and capture settings

⌘I

Documentation Index

​Webhooks

​Order Webhooks

​Order Webhook Object

Authorizations

Body

Response

Webhooks

Order Webhooks

Order Webhook Object