Orders

orders

Get details and check the status of an existing order

get/v1/orders/{order_reference_id}

Path parameters

order_reference_idstring required

The Order Reference ID to update

Query parameters

include-shipping-infoboolean

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

Response

Successful Operation

created_atstring date-time

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

captured_atstring date-time

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

capture_expirationstring date-time

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

descriptionstring

Your description for this order

amount_in_centsnumber

The total order amount in cents in original merchant currency

usd_amount_in_centsnumber

The total order amount in cents converted to USD

customer_amount_in_centsnumber

The total order amount in cents converted to customer currency

currency_codestring

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

customer_currency_codestring

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

reference_idstring

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

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

Changes

No recorded changes to this endpoint across all 3 revisions of this API.