API Reference
Tokenization
Get session status
curl --request GET \
--url https://sandbox.gateway.sezzle.com/v2/session/{session_uuid} \
--header 'Authorization: <api-key>'{
"uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
"links": [
{
"href": "https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9",
"method": "GET",
"rel": "self"
}
],
"order": {
"uuid": "12a34bc5-6de7-890f-g123-4hi1238jk902",
"intent": "CAPTURE",
"checkout_url": "https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902",
"links": [
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
"method": "GET",
"rel": "self"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
"method": "PATCH",
"rel": "self"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release",
"method": "POST",
"rel": "release"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture",
"method": "POST",
"rel": "capture"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund",
"method": "POST",
"rel": "refund"
}
],
"tokenize": {
"token": "7ec98824-67cc-469c-86ab-f9e047f9cf1a",
"expiration": "2020-04-27T14:46:59.000Z",
"approval_url": "https://dashboard.sezzle.com/customer/checkout-approval?merchant-request-id=3f3244fd-78ce-4994-af0c-b8c760d47794",
"links": [
{
"href": "https://gateway.sezzle.com/v2/token/7ec98824-67cc-469c-86ab-f9e047f9cf1a/session",
"method": "GET",
"rel": "token"
}
]
}
}
}Authorizations
The authentication token generated from providing API Keys to Sezzle Gateway
Path Parameters
The Session UUID to receive (from Create Session response)
Response
Successful Operation
Note: This example response is a multi-purpose session (create order and tokenize)
The unique identifier for this response
Available API links prefilled with UUID with accompanying method
Hide child attributes
Hide child attributes
The URL for a subsequent step
The link relationship
self, capture, checkout, create, customer, list, order, preapprove, refund, release, session, token The HTTP request method used when redirecting a customer. If omitted, will default to GET.
GET, POST, PUT, PATCH, DELETE Hide child attributes
Hide child attributes
The unique identifier for the order details provided by the merchant
If your checkout flow requires the user to confirm their checkout on your site after being approved by Sezzle, use AUTH as your intent. If you prefer the checkout be captured immediately, use CAPTURE. Submit a capture request via the API or your Merchant Dashboard before the authorization expires. The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings.
AUTH, CAPTURE The URL to which the shopper should be directed to complete their order with Sezzle
Hide child attributes
Hide child attributes
The URL for a subsequent step
The link relationship
self, capture, checkout, create, customer, list, order, preapprove, refund, release, session, token The HTTP request method used when redirecting a customer. If omitted, will default to GET.
GET, POST, PUT, PATCH, DELETE Hide child attributes
Hide child attributes
This token represents the merchant request to tokenize a customer. This token can only be used one time. Once a user accepts/denies tokenization, this token and its approval URL will be obsolete.
The expiration of the request token in ISO 8601 date/time format.
The URL for the user to accept tokenization. This URL does not create an order, it is only used for tokenizing a customer.
Hide child attributes
Hide child attributes
The URL for a subsequent step
The link relationship
self, capture, checkout, create, customer, list, order, preapprove, refund, release, session, token The HTTP request method used when redirecting a customer. If omitted, will default to GET.
GET, POST, PUT, PATCH, DELETE curl --request GET \
--url https://sandbox.gateway.sezzle.com/v2/session/{session_uuid} \
--header 'Authorization: <api-key>'{
"uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
"links": [
{
"href": "https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9",
"method": "GET",
"rel": "self"
}
],
"order": {
"uuid": "12a34bc5-6de7-890f-g123-4hi1238jk902",
"intent": "CAPTURE",
"checkout_url": "https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902",
"links": [
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
"method": "GET",
"rel": "self"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902",
"method": "PATCH",
"rel": "self"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release",
"method": "POST",
"rel": "release"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture",
"method": "POST",
"rel": "capture"
},
{
"href": "https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund",
"method": "POST",
"rel": "refund"
}
],
"tokenize": {
"token": "7ec98824-67cc-469c-86ab-f9e047f9cf1a",
"expiration": "2020-04-27T14:46:59.000Z",
"approval_url": "https://dashboard.sezzle.com/customer/checkout-approval?merchant-request-id=3f3244fd-78ce-4994-af0c-b8c760d47794",
"links": [
{
"href": "https://gateway.sezzle.com/v2/token/7ec98824-67cc-469c-86ab-f9e047f9cf1a/session",
"method": "GET",
"rel": "token"
}
]
}
}
}