API Reference
- Introduction
- Environments
- Test Data
- Postman Setup
- Errors
- Core API
- Authentication
- Sessions
- Orders
- Webhooks
- Reporting
- v1
Tokenization
- Introduction
- Customers
- Session
Create webhooks
This endpoint can be used to subscribe to webhooks
curl --request POST \
--url https://sandbox.gateway.sezzle.com/v2/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks",
"events": [
"customer.tokenized"
]
}'
{
"uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
"links": []
}
Valid Webhook Events
We accept the following Webhook events
Event | Trigger |
---|---|
customer.tokenized | A customer is tokenized |
order.authorized | An order is authorized by Sezzle |
order.captured | An order is captured by Sezzle |
order.refunded | An order is refunded by Sezzle |
dispute.merchant_input_requested | A dispute is filed by a shopper and merchant input is required |
dispute.deadline_approaching | A dispute is moved to final notice by Sezzle |
dispute.closed.customer_win | The shopper wins the dispute and the order is refunded |
dispute.closed.merchant_win | The merchant wins the dispute and it is resolved in their favor |
dispute.closed.neutral | No clear winner is determined and the dispute is resolved neutrally |
Webhook Request Payload
Unique identifier for the webhook event.
Timestamp (ISO 8601) when the event was generated.
Type of the event
Available options: customer.tokenized
, order.authorized
, order.captured
, order.refunded
, dispute.merchant_input_requested
, dispute.deadline_approaching
, dispute.closed.customer_win
, dispute.closed.merchant_win
, dispute.closed.neutral
Type of data associated with the event.
Available options: customer
, order
, dispute
Payload data specific to the event type. See options in the applicable accordion below.
Examples per Event
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"token": string,
"expiration": string,
"customer": {
"uuid": string,
"created_at": string,
"expiration": string
}
}
}
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"token": string,
"expiration": string,
"customer": {
"uuid": string,
"created_at": string,
"expiration": string
}
}
}
{
"uuid": "e41c32d5-687d-414f-b5c6-d089bea52e7d",
"created_at": "2025-04-12T00:11:01.749261Z",
"event": "customer.tokenized",
"data_type": "tokenize",
"data": {
"token": "ce56604a-5dfd-489a-80e9-753d0325dd46",
"expiration": "2025-04-12T00:41:01.745145Z",
"customer": {
"uuid": "e0003e6a-7234-4440-9265-61906e8b8879",
"created_at": "2025-04-12T00:11:01.745145Z",
"expiration": "2026-04-12T00:11:01.745145Z"
}
}
}
The merchant request token.
The expiration date and time of the token.
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"authorization": {
"uuid": string,
"created_at": string,
"authorization_amount": {
"amount_in_cents": integer,
"currency": string
},
"approved": boolean,
"expiration": string
}
}
}
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"authorization": {
"uuid": string,
"created_at": string,
"authorization_amount": {
"amount_in_cents": integer,
"currency": string
},
"approved": boolean,
"expiration": string
}
}
}
{
"uuid": "fdb263a1-a1dd-4feb-8749-c8a447977ebb",
"created_at": "2025-04-12T00:15:39.281826Z",
"event": "order.authorized",
"data_type": "order",
"data": {
"uuid": "f36605a0-4a96-46d1-9d01-a0b17140dc57",
"authorization": {
"uuid": "28ef487d-8398-43bb-8354-5ebdd1eb7b40",
"created_at": "2025-04-12T00:15:39.276841Z",
"authorization_amount": {
"amount_in_cents": 5000,
"currency": "USD"
},
"approved": true,
"expiration": "2025-04-12T00:45:39.276841Z"
}
}
}
The unique identifier for the order.
Contains the authorization response details.
The unique identifier for the authorization.
ISO 8601 timestamp when the authorization was created.
Indicates whether the authorization was approved.
ISO 8601 timestamp when the authorization will expire.
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"capture": {
"uuid": string,
"created_at": string,
"amount": {
"amount_in_cents": integer,
"currency": string
}
}
}
}
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"capture": {
"uuid": string,
"created_at": string,
"amount": {
"amount_in_cents": integer,
"currency": string
}
}
}
}
{
"uuid": "6ee025c6-8acf-48fe-a6d6-b51693d64c60",
"created_at": "2025-04-12T00:20:07.44668Z",
"event": "order.captured",
"data_type": "order",
"data": {
"uuid": "b87305a1-6be3-4877-bcf0-2b5b7dfaeaf0",
"capture": {
"uuid": "b69b1ba8-e977-4f26-9253-06f14d941696",
"created_at": "2025-04-12T00:20:07.438365Z",
"amount": {
"amount_in_cents": 3000,
"currency": "USD"
}
}
}
}
The unique identifier for the order.
Contains the capture transaction details.
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"refund": {
"uuid": string,
"created_at": string,
"amount": {
"amount_in_cents": integer,
"currency": string
}
}
}
}
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"uuid": string,
"refund": {
"uuid": string,
"created_at": string,
"amount": {
"amount_in_cents": integer,
"currency": string
}
}
}
}
{
"uuid": "ed89f046-f55e-4fdd-9f65-ec3d8e961f99",
"created_at": "2025-04-12T00:24:39.809499Z",
"event": "order.refunded",
"data_type": "order",
"data": {
"uuid": "b69f882d-06c3-4f2e-b6e3-ce7a6c46e455",
"refund": {
"uuid": "479e9d25-d0a5-49df-a2d3-6ca1d75b8c57",
"created_at": "2025-04-12T00:24:39.805651Z",
"amount": {
"amount_in_cents": 500,
"currency": "USD"
}
}
}
}
The unique identifier for the order.
Contains the refund transaction details.
The following applies to the following webhooks:
dispute.merchant_input_requested
dispute.deadline_approaching
dispute.closed.customer_win
dispute.closed.merchant_win
dispute.closed.neutral
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"customer_name": string,
"order_uuid": string,
"order_reference_id": string,
"order_date": string,
"dispute_type": string,
"dispute_due_date": string,
"dispute_id": integer,
"dispute_amount_in_cents": integer,
"dispute_currency": string,
"dispute_status": string
}
}
{
"uuid": string,
"created_at": string,
"event": string,
"data_type": string,
"data": {
"customer_name": string,
"order_uuid": string,
"order_reference_id": string,
"order_date": string,
"dispute_type": string,
"dispute_due_date": string,
"dispute_id": integer,
"dispute_amount_in_cents": integer,
"dispute_currency": string,
"dispute_status": string
}
}
{
"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",
"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"
}
}
The name of the customer who filed the dispute.
The unique identifier for the disputed order.
The reference ID of the order
The ISO 8601 date (YYYY-MM-DD) when the order was placed.
The category or reason for the dispute (e.g., “No Product Or Service”).
The deadline (ISO 8601 date) for merchant response or dispute action.
The unique ID for the dispute
The price of the dispute in cents
ISO 4217 currency code (e.g., USD).
The status of the dispute
Available options: Awaiting Merchant Response
, Merchant Final Notice
, Closed Merchant Loss
, Closed Customer Loss
, Closed All Win
Authorizations
The authentication token generated from providing API Keys to Sezzle Gateway
Body
Response
Successful Operation
The response is of type object
.
curl --request POST \
--url https://sandbox.gateway.sezzle.com/v2/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks",
"events": [
"customer.tokenized"
]
}'
{
"uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
"links": []
}