You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`terminal.refund.created`. Notification of a new Terminal refund request.
17
+
*`terminal.refund.updated`. Notification that a Terminal refund request state is changed.
18
+
19
+
* New topic [Refund Interac Payments.](https://developer.squareup.com/docs/terminal-api/square-terminal-refunds). Describes how to refund Interac payments.
20
+
21
+
***Loyalty API (beta):**
22
+
*[SearchLoyaltyAccounts.](https://developer.squareup.com/reference/square_2020-10-28/loyalty-api/search-loyalty-accounts) The endpoint supports a new query parameter to search by customer ID.
23
+
24
+
***Locations API:**
25
+
*[Location](https://developer.squareup.com/reference/square_2020-10-28/objects/Location) object. Has a new read-only field,[full_format_logo_url](https://developer.squareup.com/reference/square_2020-10-28/objects/Location#definition__property-full_format_logo_url), which provides URL of a full-format logo image for the location.
26
+
*[Webhooks.](https://developer.squareup.com/docs/webhooks-api/subscribe-to-events#locations) The Locations API now supports notifications for when a location is created and when a location is updated.
27
+
28
+
***Orders API:**
29
+
*[RetrieveOrder](https://developer.squareup.com/reference/square_2020-10-28/orders-api/retrieve-order), new endpoint. For more information, see the [Retrieve Orders](https://developer.squareup.com/docs/orders-api/manage-orders#retrieve-orders) overview.
30
+
31
+
***Invoices API (beta):**
32
+
*[Invoice](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice) object. The [payment_requests](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice#definition__property-payment_requests) field can now contain up to 13 payment requests, with a maximum of 12 `INSTALLMENT` request types. This is a service-level change that applies to all Square API versions. For more information, see [Payment requests.](https://developer.squareup.com/docs/invoices-api/overview#payment-requests)
33
+
3
34
## Version 6.4.0.20200923 (2020-09-23)
4
35
## Existing API updates
5
36
* Invoices API (beta)
@@ -167,17 +198,17 @@ Bug fixes:
167
198
## Version 5.2.0.20200422 (2020-04-22)
168
199
## API releases
169
200
***Terminal API.** The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments.
170
-
* For an overview, see [Overview](/terminal-api/overview).
201
+
* For an overview, see [Overview](https://developer.squareup.com/docs/terminal-api/overview).
171
202
* For technical reference, see [Terminal API](https://developer.squareup.com/reference/square/terminal-api).
172
203
173
204
***Devices API.** The new Devices API lets a custom third-party POS app generate a code used to sign in to a Square Terminal to create a pairing that lets the POS app send terminal checkout requests. For technical reference, see [Devices API](https://developer.squareup.com/reference/square/devices-api).
174
205
175
206
***Customer Groups API (beta).** The new Customer Groups API (Beta) enables full CRUD management of customer groups, including the ability to list, retrieve, create, update, and delete customer groups. Previously, this functionality was only available through the Square dashboard and point-of-sale product interfaces.
176
-
* For an overview, see [Overview](/customer-groups-api/what-it-does)
207
+
* For an overview, see [Overview](https://developer.squareup.com/docs/customer-groups-api/what-it-does)
177
208
* For technical reference, see [Customer Groups](https://developer.squareup.com/reference/square/customer-groups-api).
178
209
179
210
***Customer Segments API (beta).** The new Customer Segments API (Beta) lets you list and retrieve customer segment (also called smart groups) information. Coupled with the new `segment_ids` field on the customer resource, this API lets you better understand and track the customer segments to which a customer belongs.
180
-
* For an overview, see [Overview](/customer-segmentss-api/what-it-does)
211
+
* For an overview, see [Overview](https://developer.squareup.com/docs/customer-segmentss-api/what-it-does)
181
212
* For technical reference, see [Customer Segments](https://developer.squareup.com/reference/square/customer-segments-api).
182
213
183
214
@@ -215,7 +246,7 @@ Bug fixes:
215
246
*[CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square/objects/CatalogQuickAmountsSettings) type. Added to support predefined custom payment amounts in the Square Register checkout dialog box.
216
247
* ENUM`CatalogItemProductType`. The ENUM value `GIFT_CARD` is now deprecated.
217
248
218
-
***Payments API.** See [Take Payments and Collect Fees](/payments-api/take-payments-and-collect-fees) for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.
249
+
***Payments API.** See [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.
219
250
220
251
## Version 5.1.0.20200325 (2020-03-25)
221
252
## Existing API updates
@@ -263,7 +294,7 @@ All SDKs have been updated to support the following changes:
263
294
264
295
## Version 4.0.0-20191217 (2019-12-17)
265
296
!!!important
266
-
Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](/sdks).
297
+
Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](https://developer.squareup.com/docs/sdks).
267
298
!!!
268
299
269
300
*__GA release:__ SDKs updated to support new `receipt_url` and `receipt_number` fields added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type.
@@ -275,7 +306,7 @@ Square is excited to announce the public release of customized SDKs for [Java](h
275
306
276
307
## Version 3.20191120.0 (2019-11-20)
277
308
!!!important
278
-
Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](/migrate-from-v1) information page for details.
309
+
Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](https://developer.squareup.com/docs/migrate-from-v1) information page for details.
279
310
!!!
280
311
281
312
*__GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox
Copy file name to clipboardExpand all lines: README.md
+35-33Lines changed: 35 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,13 @@ Install the latest SDK using pip:
22
22
pip install squareup
23
23
```
24
24
25
-
Alternatively in python 3, you can download or clone the sdk from [Python SDK] and then install the SDK by running Setuptools in the SDK installation directory:
25
+
Alternatively in Python 3, you can download or clone the sdk from [Python SDK] and then install the SDK by running Setuptools in the SDK installation directory:
26
26
27
27
```sh
28
28
python setup.py install --user
29
29
```
30
30
31
-
In python 2, you can install via pip:
31
+
In Python 2, you can install via pip:
32
32
33
33
```sh
34
34
pip install -r requirement.txt
@@ -351,41 +351,43 @@ The Square Platform is built on the [Square API]. Square has a number of other S
351
351
352
352
You can also use the Square API to create applications or services that work with payments, orders, inventory, etc. that have been created and managed in Square’s in-person hardware products (Square Point of Sale and Square Register).
Activates a domain for use with Web Apple Pay and Square. A validation
15
+
will be performed on this domain by Apple to ensure is it properly set up as
16
+
an Apple Pay enabled domain.
17
+
18
+
This endpoint provides an easy way for platform developers to bulk activate
19
+
Web Apple Pay with Square for merchants using their platform.
20
+
21
+
To learn more about Apple Pay on Web see the Apple Pay section in the
22
+
[Square Payment Form Walkthrough](https://developer.squareup.com/docs/docs/payment-form/payment-form-walkthrough).
23
+
24
+
```python
25
+
defregister_domain(self,
26
+
body)
27
+
```
28
+
29
+
## Parameters
30
+
31
+
| Parameter | Type | Tags | Description |
32
+
| --- | --- | --- | --- |
33
+
|`body`|[`Register Domain Request`](/doc/models/register-domain-request.md)| Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
*[List Bank Accounts](/doc/api/bank-accounts.md#list-bank-accounts)
14
+
*[Get Bank Account by V1 Id](/doc/api/bank-accounts.md#get-bank-account-by-v1-id)
15
+
*[Get Bank Account](/doc/api/bank-accounts.md#get-bank-account)
16
+
17
+
18
+
# List Bank Accounts
19
+
20
+
Returns a list of [BankAccount](#type-bankaccount) objects linked to a Square account.
21
+
22
+
```python
23
+
deflist_bank_accounts(self,
24
+
cursor=None,
25
+
limit=None,
26
+
location_id=None)
27
+
```
28
+
29
+
## Parameters
30
+
31
+
| Parameter | Type | Tags | Description |
32
+
| --- | --- | --- | --- |
33
+
|`cursor`|`string`| Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |
34
+
|`limit`|`int`| Query, Optional | Upper limit on the number of bank accounts to return in the response.<br>Currently, 1000 is the largest supported limit. You can specify a limit<br>of up to 1000 bank accounts. This is also the default limit. |
35
+
|`location_id`|`string`| Query, Optional | Location ID. You can specify this optional filter<br>to retrieve only the linked bank accounts belonging to a specific location. |
36
+
37
+
## Response Type
38
+
39
+
[`List Bank Accounts Response`](/doc/models/list-bank-accounts-response.md)
40
+
41
+
## Example Usage
42
+
43
+
```python
44
+
cursor ='cursor6'
45
+
limit =172
46
+
location_id ='location_id4'
47
+
48
+
result = bank_accounts_api.list_bank_accounts(cursor, limit, location_id)
49
+
50
+
if result.is_success():
51
+
print(result.body)
52
+
elif result.is_error():
53
+
print(result.errors)
54
+
```
55
+
56
+
57
+
# Get Bank Account by V1 Id
58
+
59
+
Returns details of a [BankAccount](#type-bankaccount) identified by V1 bank account ID.
60
+
61
+
```python
62
+
defget_bank_account_by_v1_id(self,
63
+
v1_bank_account_id)
64
+
```
65
+
66
+
## Parameters
67
+
68
+
| Parameter | Type | Tags | Description |
69
+
| --- | --- | --- | --- |
70
+
|`v1_bank_account_id`|`string`| Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
71
+
72
+
## Response Type
73
+
74
+
[`Get Bank Account by V1 Id Response`](/doc/models/get-bank-account-by-v1-id-response.md)
75
+
76
+
## Example Usage
77
+
78
+
```python
79
+
v1_bank_account_id ='v1_bank_account_id8'
80
+
81
+
result = bank_accounts_api.get_bank_account_by_v1_id(v1_bank_account_id)
82
+
83
+
if result.is_success():
84
+
print(result.body)
85
+
elif result.is_error():
86
+
print(result.errors)
87
+
```
88
+
89
+
90
+
# Get Bank Account
91
+
92
+
Returns details of a [BankAccount](#type-bankaccount)
93
+
linked to a Square account.
94
+
95
+
```python
96
+
defget_bank_account(self,
97
+
bank_account_id)
98
+
```
99
+
100
+
## Parameters
101
+
102
+
| Parameter | Type | Tags | Description |
103
+
| --- | --- | --- | --- |
104
+
|`bank_account_id`|`string`| Template, Required | Square-issued ID of the desired `BankAccount`. |
105
+
106
+
## Response Type
107
+
108
+
[`Get Bank Account Response`](/doc/models/get-bank-account-response.md)
109
+
110
+
## Example Usage
111
+
112
+
```python
113
+
bank_account_id ='bank_account_id0'
114
+
115
+
result = bank_accounts_api.get_bank_account(bank_account_id)
0 commit comments