Checkout API

Square Order Checkout

An application can generate a checkout page by specifying an order in a CreatePaymentLink request (see Checkout API Overview). The following example request specifies an Order object. For simplicity, the example specifies four ad hoc line items. You can also use catalog items. For more information, see Create Orders.

Create Payment Link

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

curl https://connect.squareupsandbox.com/v2/online-checkout/payment-links \
  -X POST \
  -H 'Square-Version: 2023-08-16' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "{UNIQUE_KEY}",
    "order": {
      "location_id": "{LOCATION_ID}",
      "line_items": [
        {
          "name": "60,000 mile maintenance",
          "quantity": "1",
          "base_price_money": {
            "amount": 30000,
            "currency": "USD"
          },
          "note": "1st line item note"
        },
        {
          "name": "Tire rotation and balancing",
          "quantity": "1",
          "base_price_money": {
            "amount": 15000,
            "currency": "USD"
          }
        },
        {
          "name": "Wiper fluid replacement",
          "quantity": "1",
          "base_price_money": {
            "amount": 1900,
            "currency": "USD"
          }
        },
        {
          "name": "Oil change",
          "quantity": "1",
          "base_price_money": {
            "amount": 2000,
            "currency": "USD"
          }
        }
      ]
    }
  }'

After receiving the requests, Square creates an order, creates a checkout page, and returns the order_id and URL to the checkout page in the response. The following is an example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

{
  "payment_link": {
    "id": "DT77WJMWL4Q72DL5",
    "version": 1,
    "description": "",
    "order_id": "giFLhtoDkFd29kkccWYHzW2Bh3LZY",
    "url": "https://sandbox.square.link/u/QKhT5kUc",
    "created_at": "2022-03-16T01:59:01Z"
  },
  "related_resources": {
    "orders": [
      {
        "id": "C0DMgui6YFmgyURVSRtxr4EShheZY",
        "location_id": "{{LOCATION_ID}}",
        "source": {
          "name": "Test Online Checkout Application"
        },
        "line_items": [
          {
            "uid": "8YX13D1U3jO7czP8JVrAR",
            "name": "Auto Detailing",
            "quantity": "1",
            "item_type": "ITEM",
            "base_price_money": {
              "amount": 12500,
              "currency": "USD"
            },
            "variation_total_price_money": {
              "amount": 12500,
              "currency": "USD"
            },
            "gross_sales_money": {
              "amount": 12500,
              "currency": "USD"
            },
            "total_tax_money": {
              "amount": 0,
              "currency": "USD"
            },
            "total_discount_money": {
              "amount": 0,
              "currency": "USD"
            },
            "total_money": {
              "amount": 12500,
              "currency": "USD"
            }
          }
        ],
        "fulfillments": [
          {
            "uid": "bBpNrxjdQxGQP16sTmdzi",
            "type": "DIGITAL",
            "state": "PROPOSED"
          }
        ],
        "net_amounts": {
          "total_money": {
            "amount": 12500,
            "currency": "USD"
          },
          "tax_money": {
            "amount": 0,
            "currency": "USD"
          },
          "discount_money": {
            "amount": 0,
            "currency": "USD"
          },
          "tip_money": {
            "amount": 0,
            "currency": "USD"
          },
          "service_charge_money": {
            "amount": 0,
            "currency": "USD"
          }
        },
        "created_at": "2022-03-03T00:53:15.829Z",
        "updated_at": "2022-03-03T00:53:15.829Z",
        "state": "DRAFT",
        "version": 1,
        "total_money": {
          "amount": 12500,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_tip_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_service_charge_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ]
  }
}

Applications can use the order ID to access the order details using the Orders API (RetrieveOrder endpoint).

The application can send the payment link to the buyer. The buyer experience is identical to what is described in Quick Pay Checkout.

Link to section
See also

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.

Docs

Square Order Checkout

Link to section See also

Link to section
See also