Commandes

GET

orders

{order_reference_id}

orders

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}', 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/v1/orders/{order_reference_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "created_at": "2025-06-19T19:34:57.000Z",
  "captured_at": "2025-06-19T19:35:33.000Z",
  "capture_expiration": "2025-06-26T19:35:15.000Z",
  "description": "Order #1800",
  "amount_in_cents": 12999,
  "usd_amount_in_cents": 12999,
  "customer_amount_in_cents": 12999,
  "currency_code": "USD",
  "customer_currency_code": "USD",
  "reference_id": "ord_12345",
  "shipping_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "billing_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@sezzle.com",
    "phone": "8885401867"
  },
  "refunds": [
    {
      "amount": {
        "amount_in_cents": 500,
        "currency": "USD"
      },
      "refund_id": "7b33e7b6-f112-4844-a3c5-91688a6c00b7",
      "refund_reason": "Item returned by user",
      "is_full_refund": false,
      "order_reference_id": "ord_12345",
      "created_at": "2025-06-19T19:41:09Z"
    }
  ],
  "metadata": {
    "location_id": 123,
    "store_manager": "Jane Doe",
    "store_name": "Downtown Minneapolis"
  },
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "sezzle_order_id": "d1a6c-soq9b-j96fj-14700",
  "checkout_expiration": "2025-06-19T20:04:57.000Z",
  "checkout_status": "completed"
}

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

{
  "status": 401,
  "id": "unauthorized",
  "message": "authorization not accepted"
}

{
  "status": 404,
  "id": "record_not_found",
  "message": "not found"
}

{
  "status": 422,
  "id": "invalid",
  "message": "Unprocessable entity"
}

Vous consultez la Version 1 de l’API Sezzle. Découvrez la version actuelle!

Autorisations

Authorization

string

header

requis

The authentication token generated from providing API Keys to Sezzle Gateway

Paramètres de chemin

order_reference_id

string

requis

The Order Reference ID to update

Paramètres de requête

include-shipping-info

boolean

If your checkout post data required us to collect shipping information from the customer, then you can request that information alongside the order details.

Réponse

Successful Operation

created_at

string<date-time>

The date the session was created in ISO 8601 date/time format

captured_at

string<date-time>

The date the order was captured in ISO 8601 date/time format

capture_expiration

string<date-time>

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

description

string

Your description for this order

amount_in_cents

number

The total order amount in cents in original merchant currency

usd_amount_in_cents

number

The total order amount in cents converted to USD

customer_amount_in_cents

number

The total order amount in cents converted to customer currency

currency_code

string

The original merchant 3 character currency code as defined by ISO 4217

customer_currency_code

string

The customer's 3 character currency code as defined by ISO 4217

reference_id

string

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

shipping_address

object

The customer's shipping address

Hide child attributes

shipping_address.name

string

The name on the address

shipping_address.street

string

The street and number of the address

shipping_address.street2

string

The apt or unit

shipping_address.city

string

The city

shipping_address.state

string

The 2 character state code

shipping_address.postal_code

string

The postal delivery code

shipping_address.country_code

string

The 2 character country code

shipping_address.phone_number

string

The phone number at the delivery location

billing_address

object

The customer's billing address

Hide child attributes

billing_address.name

string

The name on the address

billing_address.street

string

The street and number of the address

billing_address.street2

string

The apt or unit

billing_address.city

string

The city

billing_address.state

string

The 2 character state code

billing_address.postal_code

string

The postal delivery code

billing_address.country_code

string

The 2 character country code

billing_address.phone_number

string

The phone number at the delivery location

customer

object

The customer's basic contact information

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

refunds

object[]

Refunded funds event detail

Hide child attributes

refunds.amount

object

The amount in cents for the transaction

Hide child attributes

refunds.amount.amount_in_cents

integer

requis

The amount in cents

refunds.amount.currency

string

requis

The 3 character currency code as defined by ISO 4217

refunds.created_at

string<date-time>

The UTC time and date when the refund was issued

refunds.is_full_refund

boolean

Whether the transaction is the full amount of the order

refunds.order_reference_id

string

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

refunds.refund_id

string

UUID for the Refund. Must be unique to a Merchant

refunds.refund_reason

string

A reason for the refund

metadata

object

Object for any custom data you want to submit with the checkout. You are not limited to the key-value pairs shown in the example, and you may use any key-value pairs you like

Hide child attributes

metadata.any

string

Custom metadata field

items

object[]

The items being purchased

Hide child attributes

items.name

string

The name of the item

items.sku

string

The sku identifier

items.quantity

integer

The quantity purchased

items.price

object

The price of the product before tax and discounts

Hide child attributes

items.price.amount_in_cents

integer

requis

The amount in cents

items.price.currency

string

requis

The 3 character currency code as defined by ISO 4217

items.category_path

string

The category path where the product is located. Use > only as the category delimiter, not as part of a product or category name. Example: Camping Gear & Supplies > Tents & Shelters.

checkout_expiration

string<date-time>

The date until which the shopper can access the checkout_url generated in Create Session request to complete the order. ISO 8601 date/time format

Finaliser un paiementInitiate order payment capture if `merchant_completes` was `true` at Create Checkout. An example use-case is if users need to return to the merchant's site before finalizing the purchase with Sezzle. Submit the Complete Checkout request within 30 minutes after the user is redirected to the merchant's site. Failure to do so results in Sezzle canceling the checkout. The default expiration period for new orders can be extended up to 7 days via the Merchant Dashboard.

⌘I

orders

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}', 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/v1/orders/{order_reference_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "created_at": "2025-06-19T19:34:57.000Z",
  "captured_at": "2025-06-19T19:35:33.000Z",
  "capture_expiration": "2025-06-26T19:35:15.000Z",
  "description": "Order #1800",
  "amount_in_cents": 12999,
  "usd_amount_in_cents": 12999,
  "customer_amount_in_cents": 12999,
  "currency_code": "USD",
  "customer_currency_code": "USD",
  "reference_id": "ord_12345",
  "shipping_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "billing_address": {
    "name": "John Doe",
    "street": "123 West Lake street",
    "street2": "104",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55408",
    "country_code": "US"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@sezzle.com",
    "phone": "8885401867"
  },
  "refunds": [
    {
      "amount": {
        "amount_in_cents": 500,
        "currency": "USD"
      },
      "refund_id": "7b33e7b6-f112-4844-a3c5-91688a6c00b7",
      "refund_reason": "Item returned by user",
      "is_full_refund": false,
      "order_reference_id": "ord_12345",
      "created_at": "2025-06-19T19:41:09Z"
    }
  ],
  "metadata": {
    "location_id": 123,
    "store_manager": "Jane Doe",
    "store_name": "Downtown Minneapolis"
  },
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "sezzle_order_id": "d1a6c-soq9b-j96fj-14700",
  "checkout_expiration": "2025-06-19T20:04:57.000Z",
  "checkout_status": "completed"
}

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

{
  "status": 401,
  "id": "unauthorized",
  "message": "authorization not accepted"
}

{
  "status": 404,
  "id": "record_not_found",
  "message": "not found"
}

{
  "status": 422,
  "id": "invalid",
  "message": "Unprocessable entity"
}

Référence API

Tokenisation

v1 (obsolète)

Autorisations

Paramètres de chemin

Paramètres de requête

Réponse