Create Order

This is the first step in the on file grant purchase process. Use the token in the response to initiate the payment

Authentication

AuthorizationBasic

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

Request

This endpoint expects an object.

requestIdstringRequiredformat: "uuid"<=64 characters

A unique identifier for the request, used for idempotency

grantIdstringRequired

ID of the grant used to create this order

amountobjectRequired

The total amount of the order

enrichmentsobjectRequired

Describes additional fields beyond core payment information.

consumerobjectOptional

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 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 contact and identification details for a user.

billingobjectOptional

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.

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>

shippingobjectOptional

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

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

itemslist of objectsOptional

discountslist of objectsOptional

merchantReferencestringOptional<=128 characters

The reference/order ID in the merchant’s system

shippingAmountobjectOptional

The shipping cost amount

taxAmountobjectOptional

The tax amount

courierobjectOptional

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](https://www.iso.org/iso-8601-date-and-time-format.html) 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.

Response

Created

tokenstring

expiresstringformat: "date-time"

1	curl -X POST https://global-api-sandbox.afterpay.com/v2/orders \
2	-H "Content-Type: application/json" \
3	-u "<username>:<password>" \
4	-d '{
5	"requestId": "123e4567-e89b-12d3-a456-426614174000",
6	"grantId": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
7	"amount": {
8	"amount": "100.00",
9	"currency": "AUD"
10	},
11	"enrichments": {
12	"initiation": {
13	"actor": "CUSTOMER"
14	}
15	}
16	}'

Authentication

Headers

Request

Response

Errors

1	{
2	"token": "001.8v3cpfue87bl9gcv6ampnfct9ts5o9vis39vee9tlor2aq6a",
3	"expires": "2025-07-24T03:47:25.278Z"
4	}