Obtenir les détails de la commande

GET

order

{order_uuid}

Get order details

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v2/order/{order_uuid} \
  --header 'Authorization: <api-key>'

{
  "uuid": "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"
    }
  ],
  "intent": "AUTH",
  "reference_id": "ord_12345",
  "description": "sezzle-store - #12749253509255",
  "checkout_expiration": "2022-03-30T21:59:17.000Z",
  "checkout_status": "active",
  "metadata": {
    "location_id": "123",
    "store_name": "Downtown Minneapolis",
    "store_manager": "Jane Doe"
  },
  "order_amount": {
    "amount_in_cents": 10000,
    "currency": "USD"
  },
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "tax_amount": {
    "amount_in_cents": 500,
    "currency": "USD"
  },
  "shipping_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "shipping_method": {
    "name": "Standard Shipping",
    "description": "4-5 days standard shipping method"
  },
  "is_upcharge": false,
  "upcharges": [
    {
      "uuid": "9f8e7d6c-5b4a-3210-9876-54321fedcba0",
      "amount": {
        "amount_in_cents": 500,
        "currency": "USD"
      }
    }
  ],
  "customer": {
    "email": "john.doe@sezzle.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "5555045294",
    "billing_address": {
      "name": "John Doe",
      "street": "123 Queen Street West",
      "street2": "Unit 104",
      "city": "Toronto",
      "state": "ON",
      "postal_code": "M5H 2M9",
      "country_code": "CA",
      "phone": "5555045294"
    },
    "shipping_address": {
      "name": "John Doe,",
      "street": "123 Queen Street West,",
      "street2": "Unit 104,",
      "city": "Toronto,",
      "state": "ON,",
      "postal_code": "M5H 2M9",
      "country_code": "CA",
      "phone": "5555045294"
    }
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 10000,
      "currency": "USD"
    },
    "authorization_amount_in_user_currency": {
      "amount_in_cents": 13700,
      "currency": "CAD"
    },
    "approved": true,
    "expiration": "2020-04-23T16:13:44Z",
    "financing_option": "4-pay-biweekly",
    "sezzle_order_id": "order-id-in-merchant-dashboard",
    "releases": [
      {
        "uuid": "4b4d217c-18f1-4bfb-996e-767470c04661",
        "amount": {
          "amount_in_cents": 3000,
          "currency": "USD"
        }
      }
    ],
    "captures": [
      {
        "uuid": "f4415e94-e562-47cc-94f3-92279f27dc20",
        "amount": {
          "amount_in_cents": 7000,
          "currency": "USD"
        }
      }
    ],
    "refunds": [
      {
        "uuid": "83162d2f-d5f1-43ad-91ed-e8231920ce6d",
        "amount": {
          "amount_in_cents": 1000,
          "currency": "USD"
        }
      }
    ]
  }
}

Autorisations

Authorization

string

header

requis

The authentication token generated from providing API Keys to Sezzle Gateway

Paramètres de chemin

order_uuid

string

requis

The Order UUID to retrieve (order.uuid from session response)

Réponse

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

requis

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)

Options disponibles:

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

Options disponibles:

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

Options disponibles:

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

requis

The amount in cents

order_amount.currency

string

requis

The 3 character currency code as defined by ISO 4217

description

string

Your description for this order

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.

items.brand

string

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

items.image_url

string

The fully qualified URL that shows the image

items.product_url

string

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

items.global_trade_item_number

string

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

items.manufacturer_part_number

string

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

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

checkout_status

enum<string>

The state of the checkout, not an indication of capture status. Active: Session created, pending shopper order completion Completed: Shopper has completed the order Deleted: Session expired or deleted, or funds released Denied: Order total exceeds the user's approved Sezzle spending power. Note: If order exceeds Sezzle merchant order limit, the status will not be denied.

Options disponibles:

active,

complete,

denied,

deleted

tax_amount

object

The taxes applied to this order, amount is included in the order total, only available if included in session request or obtained for express checkout

Hide child attributes

tax_amount.amount_in_cents

integer

The amount in cents

tax_amount.currency

string

The 3 character currency code as defined by ISO 4217

shipping_amount

object

The shipping fees applied to this order, amount is included in the order total, only available if included in session request or obtained for express checkout

Hide child attributes

shipping_amount.amount_in_cents

integer

The amount in cents

shipping_amount.currency

string

The 3 character currency code as defined by ISO 4217

shipping_method

object

Shipping method would be returned only for express checkout once the shopper selects from the available options.

Hide child attributes

shipping_method.name

string

The name of the shipping method

shipping_method.description

string

The description of the shipping method

is_upcharge

boolean

True if this order was created via the Upcharge endpoint to capture an additional amount on a parent order.

parent_order_uuid

string

When is_upcharge is true, the UUID of the original (parent) order that this upcharge was applied to.

upcharges

object[]

When this order is a parent that has had upcharges applied, lists each upcharge order's UUID and amount. Use the listed UUIDs with other Order API endpoints (Get Order, Capture, Refund, etc.).

Hide child attributes

upcharges.uuid

string

The UUID of the upcharge order

upcharges.amount

object

The amount of the upcharge

Hide child attributes

upcharges.amount.amount_in_cents

integer

requis

The amount in cents

upcharges.amount.currency

string

requis

The 3 character currency code as defined by ISO 4217

customer

object

The customer details on the order, amended with user name, email, and phone from Sezzle account

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

The name on the address

customer.billing_address.street

string

The street and number of the address

customer.billing_address.street2

string

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

The phone number at the delivery location

customer.shipping_address

object

The customer's shipping address

Hide child attributes

customer.shipping_address.name

string

The name on the address

customer.shipping_address.street

string

The street and number of the address

customer.shipping_address.street2

string

The apt or unit

customer.shipping_address.city

string

The city

customer.shipping_address.state

string

The 2 character state code

customer.shipping_address.postal_code

string

The postal delivery code

customer.shipping_address.country_code

string

The 2 character country code

customer.shipping_address.phone

string

The phone number at the delivery location

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

requis

The amount in cents

authorization.authorization_amount.currency

string

requis

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

requis

The amount in cents

authorization.authorization_amount_in_user_currency.currency

string

requis

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

authorization.releases

object[]

Released funds event details

Hide child attributes

authorization.releases.amount_in_cents

integer

The amount in cents for the transaction

authorization.releases.authorization_token

string

The checkout UUID from the order

authorization.releases.currency_code

string

The 3 character currency code as defined by ISO 4217

authorization.releases.is_full

boolean

Whether the transaction is the full amount of the order

authorization.releases.namespace

string

Might be be gateway or checkout

authorization.releases.token

string

The tokenization UUID attached to this customer

authorization.releases.group_id

string

authorization.captures

object[]

Captured funds event details

Hide child attributes

authorization.captures.amount_in_cents

integer

The amount in cents for the transaction

authorization.captures.authorization_token

string

The checkout UUID from the order

authorization.captures.currency_code

string

The 3 character currency code as defined by ISO 4217

authorization.captures.is_full

boolean

Whether the transaction is the full amount of the order

authorization.captures.namespace

string

Might be be gateway or checkout

authorization.captures.token

string

The tokenization UUID attached to this customer

authorization.captures.group_id

string

authorization.refunds

object[]

Refunded funds event detail

Hide child attributes

authorization.refunds.amount_in_cents

integer

The amount in cents for the transaction

authorization.refunds.authorization_token

string

The checkout UUID from the order

authorization.refunds.currency_code

string

The 3 character currency code as defined by ISO 4217

authorization.refunds.is_full

boolean

Whether the transaction is the full amount of the order

authorization.refunds.namespace

string

Might be be gateway or checkout

authorization.refunds.token

string

The tokenization UUID attached to this customer

authorization.refunds.group_id

string

authorization.financing_option

enum<string>

currently not supported, defaults to 4-pay-biweekly

Options disponibles:

4-pay-biweekly,

4-pay-monthly,

6-pay-monthly

authorization.sezzle_order_id

string

Sezzle Order ID reflected in Merchant Dashboard

Capturer un montant par commandeCapture an amount by order, either in full or partial capture, in cases when the order items are shipped separately.\ Can be performed after shopper has authorized the transaction by completing checkout with Sezzle, but before authorization expires

⌘I

Get order details

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v2/order/{order_uuid} \
  --header 'Authorization: <api-key>'

{
  "uuid": "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"
    }
  ],
  "intent": "AUTH",
  "reference_id": "ord_12345",
  "description": "sezzle-store - #12749253509255",
  "checkout_expiration": "2022-03-30T21:59:17.000Z",
  "checkout_status": "active",
  "metadata": {
    "location_id": "123",
    "store_name": "Downtown Minneapolis",
    "store_manager": "Jane Doe"
  },
  "order_amount": {
    "amount_in_cents": 10000,
    "currency": "USD"
  },
  "items": [
    {
      "name": "widget",
      "sku": "sku123456",
      "quantity": 1,
      "price": {
        "amount_in_cents": 1000,
        "currency": "USD"
      }
    }
  ],
  "tax_amount": {
    "amount_in_cents": 500,
    "currency": "USD"
  },
  "shipping_amount": {
    "amount_in_cents": 1000,
    "currency": "USD"
  },
  "shipping_method": {
    "name": "Standard Shipping",
    "description": "4-5 days standard shipping method"
  },
  "is_upcharge": false,
  "upcharges": [
    {
      "uuid": "9f8e7d6c-5b4a-3210-9876-54321fedcba0",
      "amount": {
        "amount_in_cents": 500,
        "currency": "USD"
      }
    }
  ],
  "customer": {
    "email": "john.doe@sezzle.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "5555045294",
    "billing_address": {
      "name": "John Doe",
      "street": "123 Queen Street West",
      "street2": "Unit 104",
      "city": "Toronto",
      "state": "ON",
      "postal_code": "M5H 2M9",
      "country_code": "CA",
      "phone": "5555045294"
    },
    "shipping_address": {
      "name": "John Doe,",
      "street": "123 Queen Street West,",
      "street2": "Unit 104,",
      "city": "Toronto,",
      "state": "ON,",
      "postal_code": "M5H 2M9",
      "country_code": "CA",
      "phone": "5555045294"
    }
  },
  "authorization": {
    "authorization_amount": {
      "amount_in_cents": 10000,
      "currency": "USD"
    },
    "authorization_amount_in_user_currency": {
      "amount_in_cents": 13700,
      "currency": "CAD"
    },
    "approved": true,
    "expiration": "2020-04-23T16:13:44Z",
    "financing_option": "4-pay-biweekly",
    "sezzle_order_id": "order-id-in-merchant-dashboard",
    "releases": [
      {
        "uuid": "4b4d217c-18f1-4bfb-996e-767470c04661",
        "amount": {
          "amount_in_cents": 3000,
          "currency": "USD"
        }
      }
    ],
    "captures": [
      {
        "uuid": "f4415e94-e562-47cc-94f3-92279f27dc20",
        "amount": {
          "amount_in_cents": 7000,
          "currency": "USD"
        }
      }
    ],
    "refunds": [
      {
        "uuid": "83162d2f-d5f1-43ad-91ed-e8231920ce6d",
        "amount": {
          "amount_in_cents": 1000,
          "currency": "USD"
        }
      }
    ]
  }
}