Get Checkout | Welcome to Afterpay Documentation

This endpoint retrieves an incomplete individual checkout by token.

Checkout details are only retained in this temporary format for up to 60 minutes. If a checkout token expires or has an order created against it, it can no longer be retrieved from this endpoint. To retrieve a Payment record (Afterpay Order) along with its associated checkout details, see Get Payment By Token.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path parameters

tokenstringRequired

The token of the checkout to be retrieved.

Response

Returns an object combining the Checkout Request and Checkout Response for a provided token.

amountobject

Object containing amount and currency.

Where a Money object is included in an API request, it will be validated according to the specification above. Invalid Money objects will trigger a 422 Unprocessable Entity response. The following is a list of common examples:

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

Object containing amount and currency. Where a Money object is included in an API request, it will be validated according to the specification above. Invalid Money objects will trigger a **422 Unprocessable Entity response**. The following is a list of common examples: |Example| errorCode| message| |---|---|---| |`amount` is omitted or null |invalid_object |{Money object}.amount Amount field required| |`amount` has more than 2 decimal places | invalid_object amount| must be a valid ISO 4217 format value| |`amount` includes a thousands separator comma, for example: "1,000" |invalid_amount |Amount must be a valid ISO 4217 format value| |`amount` is not a decimal number, for example: "FREE", "$2" or an empty string |invalid_object| {Money object}.amount Amount field must be a valid ISO 4217 format value| |`currency` is omitted or null |invalid_object| {Money object}.currency Currency field required| |`currency` is not a valid currency code, not all uppercase or an empty string |invalid_object| {Money object}.currency Currency not supported for this merchant| |`currency` is supported by Afterpay, but not valid for the Merchant account |unsupported_currency |An error occurred|

consumerobject

The consumer data model is used for gathering essential user information. It captures details such as the individual’s first name, represented by givenNames, and their last name, captured under surname. In addition, it stores the user’s contact number under phoneNumber and their email address under email. These fields collectively provide indispensable contact and identification details for a user.

The consumer data model is used for gathering essential user information. It captures details such as the individual's first name, represented by `givenNames`, and their last name, captured under `surname`. In addition, it stores the user's contact number under `phoneNumber` and their email address under `email`. These fields collectively provide indispensable contact and identification details for a user.

agreementslist of objects or null

List of agreements

billingobject or null

This data model is used for storing an individual’s contact information. Mandatory fields such as name, line1, area1, region, postcode, and countryCode help in capturing vital information about a user’s location.

The line2 and area2 fields provide additional space for extended addresses, while phoneNumber can be used to store the user’s contact number.

Important Note

The area1, area2 and region properties feature localized terminology based on country. Refer to the property descriptions for insights on each country’s specific usage

This data model is used for storing an individual's contact information. Mandatory fields such as **name**, **line1**, **area1**, **region**, **postcode**, and **countryCode** help in capturing vital information about a user's location. The `line2` and `area2` fields provide additional space for extended addresses, while `phoneNumber` can be used to store the user's contact number. <Warning title="Important Note"> The `area1`, `area2` and `region` properties feature localized terminology based on country. Refer to the property descriptions for insights on each country's specific usage </Warning>

courierobject or null

Essential information for tracking a shipment. The shippedAt key represents the date and time when the item was shipped. This value follows the ISO 8601 standard format for date and time representations.

The name field indicates the courier service employed to handle the shipment (e.g. FEDEX, UPS). For orders that are picked up in-store (also known as Buy-Online-Pickup-Instore), please use “INSTORE_PICKUP” as the name field value.

The tracking key represents a unique tracking number provided by the courier service to monitor the shipment’s progress. It’s a valuable tool for customers and businesses to track and trace their packages.

The priority field tracks the shipping speed or service level associated with the delivery.

Essential information for tracking a shipment. The `shippedAt` key represents the date and time when the item was shipped. This value follows the ISO 8601 standard format for date and time representations. The `name` field indicates the courier service employed to handle the shipment (e.g. FEDEX, UPS). For orders that are picked up in-store (also known as Buy-Online-Pickup-Instore), please use "INSTORE_PICKUP" as the `name` field value. The `tracking` key represents a unique tracking number provided by the courier service to monitor the shipment's progress. It's a valuable tool for customers and businesses to track and trace their packages. The `priority` field tracks the shipping speed or service level associated with the delivery.

customobject or null

Additional data depending on the goods and services you provide to customers.

discountslist of objects or null

expiresstring or null

itemslist of objects or null

merchantobject or null

merchantReferencestring or null

modeenum or nullDefaults to standard

Must be set to express to enable express checkout.

Allowed values:

redirectCheckoutUrlstring or null

shippingobject or null

The line2 and area2 fields provide additional space for extended addresses, while phoneNumber can be used to store the user’s contact number.

Important Note

The area1, area2 and region properties feature localized terminology based on country. Refer to the property descriptions for insights on each country’s specific usage

shippingAmountobject or null

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

taxAmountobject or null

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

tokenstring or null

descriptionstring or nullDeprecated

Errors

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/checkouts/token"
4
5	headers = {
6	"User-Agent": "User-Agent",
7	"Authorization": "Basic <username>:<password>"
8	}
9
10	response = requests.get(url, headers=headers)
11
12	print(response.json())

1	{
2	"amount": {
3	"amount": "100.00",
4	"currency": "AUD"
5	},
6	"consumer": {
7	"email": "test@example.com",
8	"givenNames": "Joe",
9	"surname": "Consumer",
10	"phoneNumber": "0400 000 000"
11	},
12	"agreements": [
13	{
14	"type": "BILLING",
15	"merchantReference": "merchant-order-12345"
16	}
17	],
18	"billing": {
19	"name": "Joe Consumer",
20	"line1": "Level 8",
21	"area1": "Melbourne",
22	"region": "VIC",
23	"postcode": "3000",
24	"countryCode": "AU",
25	"line2": "390 Collins Street",
26	"area2": "string",
27	"phoneNumber": "0400 000 000"
28	},
29	"courier": {
30	"shippedAt": "2023-08-24T14:15:22Z",
31	"name": "Australia Post",
32	"tracking": "AA0000000000000",
33	"priority": "STANDARD"
34	},
35	"custom": {},
36	"discounts": [
37	{
38	"displayName": "New Customer Coupon",
39	"amount": {
40	"amount": "100.00",
41	"currency": "AUD"
42	}
43	}
44	],
45	"expires": "2023-08-29T00:00:00.000Z",
46	"items": [
47	{
48	"name": "Blue Carabiner",
49	"quantity": 1,
50	"price": {
51	"amount": "100.00",
52	"currency": "AUD"
53	},
54	"sku": "string",
55	"pageUrl": "https://merchant.example.com/carabiner-354193.html",
56	"imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg",
57	"categories": [
58	[
59	"string"
60	]
61	],
62	"estimatedShipmentDate": "2023-08-01",
63	"preorder": false
64	}
65	],
66	"merchant": {
67	"redirectConfirmUrl": "https://example.com/checkout/confirm",
68	"redirectCancelUrl": "https://example.com/checkout/cancel",
69	"popupOriginUrl": "https://merchant.com/cart",
70	"name": "string"
71	},
72	"merchantReference": "string",
73	"mode": "standard",
74	"redirectCheckoutUrl": "https://portal.sandbox.afterpay.com/us/checkout/?token=005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
75	"shipping": {
76	"name": "Joe Consumer",
77	"line1": "Level 8",
78	"area1": "Melbourne",
79	"region": "VIC",
80	"postcode": "3000",
81	"countryCode": "AU",
82	"line2": "390 Collins Street",
83	"area2": "string",
84	"phoneNumber": "0400 000 000"
85	},
86	"shippingAmount": {
87	"amount": "100.00",
88	"currency": "AUD"
89	},
90	"taxAmount": {
91	"amount": "100.00",
92	"currency": "AUD"
93	},
94	"token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
95	"description": "string"
96	}

Authentication

Path parameters

Headers

Response

Important Note

Important Note

Errors

Important Note

Important Note