Create order by customer

POST

customer

{customer_uuid}

order

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "AUTH",
  "reference_id": "annual_sub_123",
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  }
}
'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order"

payload = {
    "intent": "AUTH",
    "reference_id": "annual_sub_123",
    "order_amount": {
        "amount_in_cents": 5000,
        "currency": "USD"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    intent: 'AUTH',
    reference_id: 'annual_sub_123',
    order_amount: {amount_in_cents: 5000, currency: 'USD'}
  })
};

fetch('https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intent' => 'AUTH',
    'reference_id' => 'annual_sub_123',
    'order_amount' => [
        'amount_in_cents' => 5000,
        'currency' => 'USD'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order"

	payload := strings.NewReader("{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "GET",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "PATCH",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/release",
      "method": "POST",
      "rel": "release"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/capture",
      "method": "POST",
      "rel": "capture"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/refund",
      "method": "POST",
      "rel": "refund"
    }
  ],
  "intent": "AUTH",
  "reference_id": "annual_sub_123",
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 5000,
      "currency": "USD"
    },
    "approved": true,
    "expiration": "2020-04-23T16:13:44Z"
  }
}

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

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

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

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

It is extremely important to note this API will return a 200 success if the request to create an order is successful (i.e. no errors) but the customer could not be approved for the order.Note: If you plan to tokenize a customer for the purpose of creating orders by a customer, please be advised that these orders will not include any financing options.

Authorizations

Authorization

string

header

required

The authentication token generated from providing API Keys to Sezzle Gateway

Headers

Sezzle-Request-Id

string

Unique client-generated ID to enforce idempotency

Path Parameters

customer_uuid

string

required

The Customer UUID for which to create the order

Body

application/json

intent

enum<string>

required

Use CAPTURE if payment should be captured immediately upon shopper authorization
Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment
- 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.
If not specified, the value will default to CAPTURE

Available options:

AUTH,

CAPTURE

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 (_))

order_amount

object

required

A Price object containing the total amount in cents of the order, which must be at least 100 which is $1.00. Please note your merchant configuration might have a higher minimum.

Hide child attributes

order_amount.amount_in_cents

integer

required

The amount in cents

order_amount.currency

string

required

The 3 character currency code as defined by ISO 4217

Response

Successful Operation

uuid

string

The unique identifier for this response

links

object[]

Available API links prefilled with UUID with accompanying method

Hide child attributes

links.href

string

required

The fully qualified URL for the API endpoint

links.rel

enum<string>

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)

Available options:

self,

capture,

checkout,

create,

customer,

list,

order,

preapprove,

refund,

release,

session

links.method

enum<string>

The HTTP method to use when calling this API endpoint

Available options:

GET,

POST,

PATCH,

DELETE

intent

enum<string>

Use CAPTURE if payment should be captured immediately upon shopper authorization
Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment
- 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.
If not specified, the value will default to CAPTURE

Available options:

AUTH,

CAPTURE

reference_id

string

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

order_amount

object

A Price object containing the total amount in cents of the order, which must be at least 100 which is $1.00. Please note your merchant configuration might have a higher minimum.

Hide child attributes

order_amount.amount_in_cents

integer

required

The amount in cents

order_amount.currency

string

required

The 3 character currency code as defined by ISO 4217

authorization

object

The authorization details for the order

Hide child attributes

authorization.authorization_amount

object

The amount that was authorized

Hide child attributes

authorization.authorization_amount.amount_in_cents

integer

required

The amount in cents

authorization.authorization_amount.currency

string

required

The 3 character currency code as defined by ISO 4217

authorization.authorization_amount_in_user_currency

object

Authorization amount denominated in the shopper's currency. Sezzle always settles in the shopper's local currency, so this is the amount actually authorized against the shopper's account. Useful for reconciling against the funds you receive at settlement when the shopper's currency differs from yours.

Only populated on GET /v2/order/{order_uuid} once the shopper has completed checkout and the order has been created. The field is omitted on pre-order calls and on responses from other endpoints (reauthorize, upcharge).

Hide child attributes

authorization.authorization_amount_in_user_currency.amount_in_cents

integer

required

The amount in cents

authorization.authorization_amount_in_user_currency.currency

string

required

The 3 character currency code as defined by ISO 4217

authorization.approved

boolean

Shopper approval status for the order

authorization.expiration

string<date-time>

The date until which the merchant can capture the order amount. ISO 8601 date/time format

Delete a customerDelete an existing tokenized customer

⌘I

Create order by customer

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "AUTH",
  "reference_id": "annual_sub_123",
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  }
}
'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order"

payload = {
    "intent": "AUTH",
    "reference_id": "annual_sub_123",
    "order_amount": {
        "amount_in_cents": 5000,
        "currency": "USD"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    intent: 'AUTH',
    reference_id: 'annual_sub_123',
    order_amount: {amount_in_cents: 5000, currency: 'USD'}
  })
};

fetch('https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intent' => 'AUTH',
    'reference_id' => 'annual_sub_123',
    'order_amount' => [
        'amount_in_cents' => 5000,
        'currency' => 'USD'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order"

	payload := strings.NewReader("{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/customer/{customer_uuid}/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intent\": \"AUTH\",\n  \"reference_id\": \"annual_sub_123\",\n  \"order_amount\": {\n    \"amount_in_cents\": 5000,\n    \"currency\": \"USD\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8",
  "links": [
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "GET",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8",
      "method": "PATCH",
      "rel": "self"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/release",
      "method": "POST",
      "rel": "release"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/capture",
      "method": "POST",
      "rel": "capture"
    },
    {
      "href": "https://gateway.sezzle.com/v2/order/6c9db5d4-d09a-4224-860a-b5438ac32ca8/refund",
      "method": "POST",
      "rel": "refund"
    }
  ],
  "intent": "AUTH",
  "reference_id": "annual_sub_123",
  "order_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 5000,
      "currency": "USD"
    },
    "approved": true,
    "expiration": "2020-04-23T16:13:44Z"
  }
}

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

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

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

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

API Reference

Tokenization

v1 (deprecated)

Create order by customer

Authorizations

Headers

Path Parameters

Body

Response