Create a card session

POST

session

card

Create card session

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v2/session/card \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": "https://example.com",
  "mode": "iframe",
  "merchant_reference_id": "merchant-cart-id-max-255",
  "amount_in_cents": 1000,
  "currency": "USD",
  "card_response_format": "token",
  "customer": {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "6125551234",
    "billing_address": {
      "street": "123 W Lake St",
      "street2": "Unit 104",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55408",
      "country_code": "US"
    }
  },
  "items": [
    {
      "name": "Blue tee",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ]
}
'

{
  "uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
  "dashboard_url": "https://dashboard.sezzle.com/example?id=0001"
}

This endpoint should be used with our virtual card offering. It is not intended for the direct integration flow.

Authorizations

Authorization

string

header

required

The authentication token generated from providing API Keys to Sezzle Gateway

Body

application/json

origin

string

required

The window origin of the host

mode

enum<string>

required

The mode for the order checkout. Defaults to redirect if not provided. If iframe or popup is provided, then the cancel and complete URLs must include the origin of the parent window.

Available options:

iframe,

popup,

redirect

merchant_reference_id

string

required

The checkout or cart ID from the merchant, currently used for tracking only (must contain only alphanumeric characters, dashes (-), and underscores (_))

amount_in_cents

integer

required

The amount in cents

currency

string

required

The 3 character currency code as defined by ISO 4217

card_response_format

string

Value of token required to use tokenization

items

object[]

Hide child attributes

name

string

The name of the item

sku

string

The sku identifier

quantity

integer

The quantity purchased

price

object

The price of the product before tax and discounts

Hide child attributes

price.amount_in_cents

integer

required

The amount in cents

price.currency

string

required

The 3 character currency code as defined by ISO 4217

category_path

string

The category path where the product is located. Example: Camping Gear & Supplies > Tents & Shelters.

brand

string

The products brand name as customers would recognize. Examples: Nike, Kelty, Brooks, Carhartt, Columbia

image_url

string

The fully qualified URL that shows the image

product_url

string

The fully qualified URL that links directly to the product being purchased

global_trade_item_number

string

The products Global Trade Item Number (GTIN). Common types include UPC, ISBN, EAN. Exclude dashes and spaces.

manufacturer_part_number

string

The products Manufacturer Part Number (MPN) which together with brand can uniquely identify a product.

customer

object

The customer for this session

Hide child attributes

customer.first_name

string

The customer's first name

customer.last_name

string

The customer's last name

customer.email

string

The customer's email address

customer.phone

string

The customer's phone number

customer.billing_address

object

The customer's billing address

Hide child attributes

customer.billing_address.name

string | null

The name on the address

customer.billing_address.street

string

The street and number of the address

customer.billing_address.street2

string | null

The apt or unit

customer.billing_address.city

string

The city

customer.billing_address.state

string

The 2 character state code

customer.billing_address.postal_code

string

The postal delivery code

customer.billing_address.country_code

string

The 2 character country code

customer.billing_address.phone

string | null

The phone number at the delivery location

Response

Successful Operation

uuid

string

The unique identifier for this session

dashboard_url

string

The dashboard_url is a URL which the customer should be redirected to. Upon accepting the agreements there will be a postMessage returned for the payload of the card data.

Get card data by token

⌘I

Create card session

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v2/session/card \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": "https://example.com",
  "mode": "iframe",
  "merchant_reference_id": "merchant-cart-id-max-255",
  "amount_in_cents": 1000,
  "currency": "USD",
  "card_response_format": "token",
  "customer": {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "6125551234",
    "billing_address": {
      "street": "123 W Lake St",
      "street2": "Unit 104",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55408",
      "country_code": "US"
    }
  },
  "items": [
    {
      "name": "Blue tee",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ]
}
'

{
  "uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
  "dashboard_url": "https://dashboard.sezzle.com/example?id=0001"
}

API Reference

Tokenization

v1 (deprecated)

Create a card session

Authorizations

Body

Response