ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
Square Data Dictionary
2
Terminal API :Checkouts
3
Default Panoply Table :square_business_checkouts
4
5
Field NameDescription
6
amount_moneyThe amount of money (including the tax amount) that the Square Terminal device should try to collect.
7
app_idRead only The ID of the application that created the checkout.
8
cancel_reasonRead only Present if the status is CANCELED.
9
created_atRead only The time when the TerminalCheckout was created, as an RFC 3339 timestamp.
10
deadline_durationAn RFC 3339 duration, after which the checkout is automatically canceled. A TerminalCheckout that is PENDING is automatically CANCELED and has a cancellation reason of TIMED_OUT.
11
device_optionsOptions to control the display and behavior of the Square Terminal device.
12
idRead only A unique ID for this TerminalCheckout.
13
location_idRead only The location of the device where the TerminalCheckout was directed.
14
noteAn optional note to associate with the checkout, as well as with any payments used to complete the checkout.
15
payment_idsRead only A list of IDs for payments created by this TerminalCheckout
16
payment_typeThe type of payment the terminal should attempt to capture from. Defaults to CARD_PRESENT.
17
reference_idAn optional user-defined reference ID that can be used to associate this TerminalCheckout to another entity in an external system. For example, an order ID generated by a third-party shopping cart. The ID is also associated with any payments used to complete the checkout.
18
statusRead only The status of the TerminalCheckout. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED
19
updated_atRead only The time when the TerminalCheckout was last updated, as an RFC 3339 timestamp.
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