v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

ORDERS

Get an order

Retrieves the details of an existing order.

get/v1/orders/{orderId}

Path parameters

orderIdstring required

Universally unique identifier (UUID) of the order.

Query parameters

expandstring[]

Additional information is provided as an expanded response, for example, a related object nested within the parent. See Use expandable fields.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. An order details are displayed.

amountinteger required

Total order amount in the smallest monetary unit of the merchant's currency.

amount_paidinteger

Amount currently paid toward the order total.

amount_dueinteger

Amount still due toward the order total.

tax_amountinteger

Merchant-defined flat tax amount for the order. Format: Cents

tax_amount_paidinteger

Amount currently paid toward the tax total.

tip_amountinteger

Amount paid in tips. This value is automatically added to the total amount when the transaction is finalized.

partial_authboolean

Indicates if partial approval has occurred.

amount_returnedinteger nullable

chargestring

Charge identifier. Returns the result when the order status is paid, fulfilled, or refunded.

auth_codestring nullable

Authorization code of the charge, if available.

external_coupon_codestring

External coupon code available for this order.

upstream_idstring

Billing address country, if provided.

updatedinteger

Time stamps when the order was last updated.

first6string

First 6 numbers of the primary account number.

amount_preauthorizedinteger

Displays the pre-authorized amount for the order. If any.

ref_numstring nullable

If available, the reference number returned from the payment gateway if the transaction is successful.

warning_messagestring nullable

Detailed warning information about the order or associated charge (for example, missing original transaction id for c-token).

ecomind'ecom' | 'moto' | 'retail'

Indicates who entered the card data used for a charge - customer (ecom) or merchant (moto).

createdinteger required

Displays results based on the object's created field. Values: String with a Unix timestamp (in milliseconds) or Dictionary of multiple options describing a time range.

currencystring required

Three-letter ISO 4217 currency code.

customerstring

Customer identifier.

emailstring nullable

Email address of the customer placing the order.

external_reference_idstring

An identifier such as an invoice or PO number, passed to the merchant's gateway and ultimately appears in settlement records. Note: Applicable for US customers, spaces are allowed in the reference number. Length: Max 12 (including alphanumeric characters)

external_customer_referencestring

Customer reference number from the merchant's order management system.

idstring required

Order identifier.

livemodeboolean required

Indicates whether the item is in production or sandbox. True - Item is in production False - Item is in sandbox

metadataobject required

Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters

object'order' required

Object type. Objects with the same type have the same value.

selected_shipping_methodstring nullable

Selected shipping method of the order. If present, the value is set from the shipping_methods list. For multiple shipping methods, the first method is automatically selected.

Current order status.