v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
Order

Get order details

Get details and check the status of an existing order.
Can be performed any time after session creation

get/v2/order/{order_uuid}

Path parameters

order_uuidstring required

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

Response

Successful Operation

uuidstring

The unique identifier for this response

intent'AUTH' | 'CAPTURE'
  • 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
reference_idstring

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

descriptionstring

Your description for this order

checkout_expirationstring 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'active' | 'complete' | 'denied' | 'deleted'

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.

is_upchargeboolean

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

parent_order_uuidstring

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