For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • POSTCreate Checkout
      • GETGet Checkout
        • Checkout-Request
        • Checkout-Response
LogoLogo
ReferenceCheckoutsSchemas

Checkout-Request

Example
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 "merchantReference": "string",
13 "billing": {
14 "name": "Joe Consumer",
15 "line1": "Level 5",
16 "line2": "390 Collins Street",
17 "area1": "Melbourne",
18 "region": "VIC",
19 "postcode": "3000",
20 "countryCode": "AU",
21 "phoneNumber": "0400 000 000"
22 },
23 "shipping": {
24 "name": "Joe Consumer",
25 "line1": "Level 5",
26 "line2": "390 Collins Street",
27 "area1": "Melbourne",
28 "region": "VIC",
29 "postcode": "3000",
30 "countryCode": "AU",
31 "phoneNumber": "0400 000 000"
32 },
33 "merchant": {
34 "redirectConfirmUrl": "https://example.com/checkout/confirm",
35 "redirectCancelUrl": "https://example.com/checkout/cancel",
36 "popupOriginUrl": "https://merchant.com/cart",
37 "name": "string"
38 },
39 "items": [
40 {
41 "name": "Blue Carabiner",
42 "sku": "12341234",
43 "quantity": 1,
44 "pageUrl": "https://merchant.example.com/carabiner-354193.html",
45 "imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg",
46 "price": {
47 "amount": "40.00",
48 "currency": "AUD"
49 },
50 "categories": [
51 [
52 "Sporting Goods",
53 "Climbing Equipment",
54 "Climbing",
55 "Climbing Carabiners"
56 ],
57 [
58 "Sale",
59 "Climbing"
60 ]
61 ],
62 "estimatedShipmentDate": "2023-08-01"
63 }
64 ],
65 "courier": {
66 "shippedAt": "2025-08-24T14:15:22Z",
67 "name": "USA Post",
68 "tracking": "AA0000000000000",
69 "priority": "STANDARD"
70 },
71 "taxAmount": {
72 "amount": "100.00",
73 "currency": "AUD"
74 },
75 "shippingAmount": {
76 "amount": "100.00",
77 "currency": "AUD"
78 },
79 "discounts": [
80 {
81 "displayName": "New Customer Coupon",
82 "amount": {}
83 }
84 ],
85 "description": "string",
86 "mode": "standard"
87}
Was this page helpful?
Previous

Checkout-Response

Next
Built with

Response

checkout_requestobjectRequired
Individual Checkout