Get Order

curl https://global-api-sandbox.afterpay.com/v1/orders/token/environment:environment \
     -H "User-Agent: Afterpay Online API Simulator" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "expires": "2024-06-15T16:45:00Z",
  "token": "a1b2c3d4e5f678901234567890abcdef",
  "totalAmount": {
    "amount": "149.99",
    "currency": "USD"
  },
  "consumer": {
    "phoneNumber": "+14155552671",
    "givenNames": "John",
    "surname": "Doe",
    "email": "john.doe@example.com"
  },
  "billing": {
    "name": "John Doe",
    "line1": "123 Elm Street",
    "line2": "Apt 4B",
    "area1": "San Francisco",
    "region": "CA",
    "postcode": "94107",
    "countryCode": "US"
  },
  "shipping": {
    "name": "John Doe",
    "line1": "123 Elm Street",
    "line2": "Apt 4B",
    "area1": "San Francisco",
    "region": "CA",
    "postcode": "94107",
    "countryCode": "US"
  },
  "courier": {
    "name": "FedEx",
    "phoneNumber": "+18005551234",
    "trackingUrl": "https://www.fedex.com/apps/fedextrack/?tracknumbers=123456789012"
  },
  "description": "Order for electronics and accessories",
  "merchant": {
    "redirectConfirmUrl": "https://merchant.example.com/order/confirm",
    "redirectCancelUrl": "https://merchant.example.com/order/cancel"
  },
  "paymentType": "PAY_BY_INSTALLMENT",
  "merchantReference": "ORD-20240615-1234",
  "items": [
    {
      "name": "Wireless Headphones",
      "sku": "WH-12345",
      "quantity": 1,
      "price": {
        "amount": "99.99",
        "currency": "USD"
      }
    },
    {
      "name": "Charging Cable",
      "sku": "CC-67890",
      "quantity": 1,
      "price": {
        "amount": "50.00",
        "currency": "USD"
      }
    }
  ],
  "discounts": [
    {
      "name": "Spring Sale",
      "amount": {
        "amount": "10.00",
        "currency": "USD"
      }
    }
  ],
  "shippingAmount": {
    "amount": "5.00",
    "currency": "USD"
  },
  "taxAmount": {
    "amount": "12.50",
    "currency": "USD"
  }
}

This endpoint retrieves an incomplete individual order by token. Note: Order details are only retained in this temporary format for up to 60 minutes. If an order token expires or has a payment captured against it, it can no longer be retrieved from this endpoint. To retrieve a completed payment along with its associated order details, see Get Payment By Token.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

This endpoint retrieves an incomplete individual order by token. **Note**: Order details are only retained in this temporary format for up to 60 minutes. If an order token expires or has a payment captured against it, it can no longer be retrieved from this endpoint. To retrieve a completed payment along with its associated order details, see Get Payment By Token. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

tokenstringRequired

The token of the order to be retrieved.

Response

Errors

404

Not Found Error

Attribute

Type

Description

expires

string

The UTC timestamp of when the order token will expire, in ISO 8601 format.

token

string

Order token to be used to complete payment.

totalAmount

Money

Total amount for order to be charged to consumer.

consumer

Consumer

The consumer requesting the order.

billing

Contact

Billing address.

shipping

Contact

Shipping address.

courier

Shipping Courier

Shipping courier details.

description

string

A description of the order.

merchant.redirectConfirmUrl

string

The consumer is redirected to this URL on confirmation.

merchant.redirectCancelUrl

string

The consumer to redirected to this URL if the payment process is cancelled.

paymentType

string

”PAY_BY_INSTALLMENT”

merchantReference

string

The merchant’s id/reference that this order corresponds to.

items

Item

An array of order items.

discounts

Discount

An array of discounts.

shippingAmount

Money

The shipping amount.

taxAmount

Money

The included tax amount after applying all discounts.

Attribute	Type	Description
`expires`	string	The UTC timestamp of when the order token will expire, in ISO 8601 format.
`token`	string	Order token to be used to complete payment.
`totalAmount`	Money	Total amount for order to be charged to consumer.
`consumer`	Consumer	The consumer requesting the order.
`billing`	Contact	Billing address.
`shipping`	Contact	Shipping address.
`courier`	Shipping Courier	Shipping courier details.
`description`	string	A description of the order.
`merchant`.`redirectConfirmUrl`	string	The consumer is redirected to this URL on confirmation.
`merchant`.`redirectCancelUrl`	string	The consumer to redirected to this URL if the payment process is cancelled.
`paymentType`	string	”PAY_BY_INSTALLMENT”
`merchantReference`	string	The merchant’s id/reference that this order corresponds to.
`items`	Item	An array of order items.
`discounts`	Discount	An array of discounts.
`shippingAmount`	Money	The shipping amount.
`taxAmount`	Money	The included tax amount after applying all discounts.

Connection Timeouts

Authentication

Path parameters

Headers

Response

Errors

Connection Timeouts

Authentication

Path parameters

Headers

Response

Errors