set-sdk 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- set_sdk/__init__.py +20 -0
- set_sdk/py.typed +0 -0
- set_sdk/set_api.py +1353 -0
- set_sdk/set_direct_deposit.py +381 -0
- set_sdk/webhooks.py +85 -0
- set_sdk-0.1.0.dist-info/METADATA +102 -0
- set_sdk-0.1.0.dist-info/RECORD +9 -0
- set_sdk-0.1.0.dist-info/WHEEL +5 -0
- set_sdk-0.1.0.dist-info/top_level.txt +1 -0
set_sdk/set_api.py
ADDED
|
@@ -0,0 +1,1353 @@
|
|
|
1
|
+
"""SET API 2026-11-23: generated by scripts/client-sdk.mjs from the OpenAPI document.
|
|
2
|
+
|
|
3
|
+
Do not edit; run node scripts/client-artifacts.mjs. Standard library only.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
import json
|
|
7
|
+
import urllib.error
|
|
8
|
+
import urllib.parse
|
|
9
|
+
import urllib.request
|
|
10
|
+
import uuid
|
|
11
|
+
|
|
12
|
+
DEFAULT_BASE_URL = "https://wallet-staging.simpleeasytransactions.com"
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class SetApiError(Exception):
|
|
16
|
+
"""An error answer: status, the API's error code, its message and the Request-Id to quote to SET."""
|
|
17
|
+
|
|
18
|
+
def __init__(self, status, code, message, request_id, body):
|
|
19
|
+
super().__init__(f"{status} {code}: {message}")
|
|
20
|
+
self.status = status
|
|
21
|
+
self.code = code
|
|
22
|
+
self.message = message
|
|
23
|
+
self.request_id = request_id
|
|
24
|
+
self.body = body
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class SetApiClient:
|
|
28
|
+
"""A SET API key: set_live_… in production, set_test_… in staging. One method per operation; request() makes any call."""
|
|
29
|
+
|
|
30
|
+
def __init__(self, api_key, base_url=DEFAULT_BASE_URL, set_version=None, timeout=30, transport=None):
|
|
31
|
+
if not api_key:
|
|
32
|
+
raise ValueError("api_key is required")
|
|
33
|
+
self._api_key = api_key
|
|
34
|
+
self.base_url = base_url.rstrip("/")
|
|
35
|
+
self._set_version = set_version
|
|
36
|
+
self._timeout = timeout
|
|
37
|
+
self._transport = transport or self._urllib
|
|
38
|
+
|
|
39
|
+
def _urllib(self, method, url, headers, data):
|
|
40
|
+
request = urllib.request.Request(url, data=data, headers=headers, method=method)
|
|
41
|
+
try:
|
|
42
|
+
with urllib.request.urlopen(request, timeout=self._timeout) as response:
|
|
43
|
+
return response.status, dict(response.headers), response.read()
|
|
44
|
+
except urllib.error.HTTPError as error:
|
|
45
|
+
return error.code, dict(error.headers), error.read()
|
|
46
|
+
|
|
47
|
+
def request(self, method, path, query=None, body=None, idempotency_key=None):
|
|
48
|
+
"""Any call. A POST or PUT gets a fresh Idempotency-Key unless one is given; pass the same one to retry safely."""
|
|
49
|
+
url = self.base_url + path
|
|
50
|
+
pairs = [(name, value) for name, value in (query or {}).items() if value is not None]
|
|
51
|
+
if pairs:
|
|
52
|
+
url += "?" + urllib.parse.urlencode([(name, str(value).lower() if isinstance(value, bool) else value) for name, value in pairs])
|
|
53
|
+
headers = {"Authorization": "Bearer " + self._api_key, "Accept": "application/json", "User-Agent": "set-sdk-python/0.1.0"}
|
|
54
|
+
if self._set_version:
|
|
55
|
+
headers["SET-Version"] = self._set_version
|
|
56
|
+
if method.upper() in ("POST", "PUT"):
|
|
57
|
+
headers["Idempotency-Key"] = idempotency_key or str(uuid.uuid4())
|
|
58
|
+
data = None
|
|
59
|
+
if body is not None:
|
|
60
|
+
headers["Content-Type"] = "application/json"
|
|
61
|
+
data = json.dumps(body).encode("utf-8")
|
|
62
|
+
status, response_headers, raw = self._transport(method, url, headers, data)
|
|
63
|
+
lowered = {name.lower(): value for name, value in response_headers.items()}
|
|
64
|
+
text = raw.decode("utf-8") if raw else ""
|
|
65
|
+
parsed = json.loads(text) if text and "application/json" in lowered.get("content-type", "") else text
|
|
66
|
+
if status >= 400:
|
|
67
|
+
answer = parsed if isinstance(parsed, dict) else {}
|
|
68
|
+
raise SetApiError(status, answer.get("error", "http_error"), answer.get("message", ""), answer.get("requestId") or lowered.get("request-id"), parsed)
|
|
69
|
+
return parsed
|
|
70
|
+
|
|
71
|
+
def get_ping(self):
|
|
72
|
+
"""Who this key is (scope: read). GET /v1/ping"""
|
|
73
|
+
return self.request("GET", f"/v1/ping", query=None, body=None)
|
|
74
|
+
|
|
75
|
+
def get_analytics_volume(self, *, since=None, until=None, interval=None, group_by=None):
|
|
76
|
+
"""Money in and out per period (scope: read). GET /v1/analytics/volume"""
|
|
77
|
+
return self.request("GET", f"/v1/analytics/volume", query={"since": since, "until": until, "interval": interval, "groupBy": group_by}, body=None)
|
|
78
|
+
|
|
79
|
+
def get_analytics_customers(self, *, since=None, until=None):
|
|
80
|
+
"""Each customer's totals (scope: read). GET /v1/analytics/customers"""
|
|
81
|
+
return self.request("GET", f"/v1/analytics/customers", query={"since": since, "until": until}, body=None)
|
|
82
|
+
|
|
83
|
+
def get_analytics_sales(self, *, since=None, until=None):
|
|
84
|
+
"""Invoices: invoiced, received, outstanding, refunded (scope: read). GET /v1/analytics/sales"""
|
|
85
|
+
return self.request("GET", f"/v1/analytics/sales", query={"since": since, "until": until}, body=None)
|
|
86
|
+
|
|
87
|
+
def get_analytics_states(self, *, since=None, until=None):
|
|
88
|
+
"""Counts and amounts by state (scope: read). GET /v1/analytics/states"""
|
|
89
|
+
return self.request("GET", f"/v1/analytics/states", query={"since": since, "until": until}, body=None)
|
|
90
|
+
|
|
91
|
+
def get_capabilities(self):
|
|
92
|
+
"""What this key can do today (scope: read). GET /v1/capabilities"""
|
|
93
|
+
return self.request("GET", f"/v1/capabilities", query=None, body=None)
|
|
94
|
+
|
|
95
|
+
def get_changelog(self, *, since=None, api=None):
|
|
96
|
+
"""Dated changes to the API, newest first, and what is deprecated (scope: read). GET /v1/changelog"""
|
|
97
|
+
return self.request("GET", f"/v1/changelog", query={"since": since, "api": api}, body=None)
|
|
98
|
+
|
|
99
|
+
def get_api_keys(self, *, limit=None, created_before=None, starting_after=None):
|
|
100
|
+
"""The platform's keys (scope: read). GET /v1/api_keys"""
|
|
101
|
+
return self.request("GET", f"/v1/api_keys", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
102
|
+
|
|
103
|
+
def post_api_keys(self, *, body, idempotency_key=None):
|
|
104
|
+
"""Issue a key (scope: write). POST /v1/api_keys"""
|
|
105
|
+
return self.request("POST", f"/v1/api_keys", query=None, body=body, idempotency_key=idempotency_key)
|
|
106
|
+
|
|
107
|
+
def post_api_keys_by_key_signing_key(self, key, *, body, idempotency_key=None):
|
|
108
|
+
"""Register the key's public key (request signing) (scope: write). POST /v1/api_keys/{key}/signing_key"""
|
|
109
|
+
return self.request("POST", f"/v1/api_keys/{urllib.parse.quote(str(key), safe='')}/signing_key", query=None, body=body, idempotency_key=idempotency_key)
|
|
110
|
+
|
|
111
|
+
def post_api_keys_by_key_rotate(self, key, *, body, idempotency_key=None):
|
|
112
|
+
"""Rotate a key, with an overlap (scope: write). POST /v1/api_keys/{key}/rotate"""
|
|
113
|
+
return self.request("POST", f"/v1/api_keys/{urllib.parse.quote(str(key), safe='')}/rotate", query=None, body=body, idempotency_key=idempotency_key)
|
|
114
|
+
|
|
115
|
+
def post_api_keys_by_key_revoke(self, key, *, idempotency_key=None):
|
|
116
|
+
"""Revoke another key (scope: write). POST /v1/api_keys/{key}/revoke"""
|
|
117
|
+
return self.request("POST", f"/v1/api_keys/{urllib.parse.quote(str(key), safe='')}/revoke", query=None, body=None, idempotency_key=idempotency_key)
|
|
118
|
+
|
|
119
|
+
def post_api_keys_by_key_allowed_cidrs(self, key, *, body, idempotency_key=None):
|
|
120
|
+
"""Pin a key to your servers' addresses (scope: write). POST /v1/api_keys/{key}/allowed_cidrs"""
|
|
121
|
+
return self.request("POST", f"/v1/api_keys/{urllib.parse.quote(str(key), safe='')}/allowed_cidrs", query=None, body=body, idempotency_key=idempotency_key)
|
|
122
|
+
|
|
123
|
+
def post_tos_links(self, *, body, idempotency_key=None):
|
|
124
|
+
"""The provider's hosted terms page (scope: write). POST /v1/tos_links"""
|
|
125
|
+
return self.request("POST", f"/v1/tos_links", query=None, body=body, idempotency_key=idempotency_key)
|
|
126
|
+
|
|
127
|
+
def get_customers(self, *, external_id=None, created_before=None, limit=None, starting_after=None):
|
|
128
|
+
"""List customers (scope: read). GET /v1/customers"""
|
|
129
|
+
return self.request("GET", f"/v1/customers", query={"externalId": external_id, "createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
130
|
+
|
|
131
|
+
def post_customers(self, *, body, idempotency_key=None):
|
|
132
|
+
"""Create a customer (hosted link, or KYB/KYC by API) (scope: write). POST /v1/customers"""
|
|
133
|
+
return self.request("POST", f"/v1/customers", query=None, body=body, idempotency_key=idempotency_key)
|
|
134
|
+
|
|
135
|
+
def get_customers_by_customer(self, customer):
|
|
136
|
+
"""A customer, re-read from the provider (scope: read). GET /v1/customers/{customer}"""
|
|
137
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}", query=None, body=None)
|
|
138
|
+
|
|
139
|
+
def post_customers_by_customer_endorsements(self, customer, *, body, idempotency_key=None):
|
|
140
|
+
"""A link for a currency's endorsement (scope: write). POST /v1/customers/{customer}/endorsements"""
|
|
141
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/endorsements", query=None, body=body, idempotency_key=idempotency_key)
|
|
142
|
+
|
|
143
|
+
def post_customers_by_customer_kyb(self, customer, *, body, idempotency_key=None):
|
|
144
|
+
"""More or corrected KYB/KYC data (scope: write). POST /v1/customers/{customer}/kyb"""
|
|
145
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/kyb", query=None, body=body, idempotency_key=idempotency_key)
|
|
146
|
+
|
|
147
|
+
def post_customers_by_customer_associated_persons(self, customer, *, body, idempotency_key=None):
|
|
148
|
+
"""Add an owner, director or signer (scope: write). POST /v1/customers/{customer}/associated_persons"""
|
|
149
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/associated_persons", query=None, body=body, idempotency_key=idempotency_key)
|
|
150
|
+
|
|
151
|
+
def get_customers_by_customer_tos_link(self, customer, *, redirect_uri=None):
|
|
152
|
+
"""Terms link for an existing customer (scope: read). GET /v1/customers/{customer}/tos_link"""
|
|
153
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/tos_link", query={"redirectUri": redirect_uri}, body=None)
|
|
154
|
+
|
|
155
|
+
def get_customers_by_customer_rfis(self, customer, *, state=None):
|
|
156
|
+
"""The provider's requests for information (scope: read). GET /v1/customers/{customer}/rfis"""
|
|
157
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/rfis", query={"state": state}, body=None)
|
|
158
|
+
|
|
159
|
+
def post_rfis_by_rfi_responses(self, rfi, *, body, idempotency_key=None):
|
|
160
|
+
"""Answer an RFI (scope: write). POST /v1/rfis/{rfi}/responses"""
|
|
161
|
+
return self.request("POST", f"/v1/rfis/{urllib.parse.quote(str(rfi), safe='')}/responses", query=None, body=body, idempotency_key=idempotency_key)
|
|
162
|
+
|
|
163
|
+
def post_customers_by_customer_close(self, customer, *, body, idempotency_key=None):
|
|
164
|
+
"""Close a customer (scope: write). POST /v1/customers/{customer}/close"""
|
|
165
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/close", query=None, body=body, idempotency_key=idempotency_key)
|
|
166
|
+
|
|
167
|
+
def post_payment_setups(self, *, body, idempotency_key=None):
|
|
168
|
+
"""One call per way (scope: write). POST /v1/payment_setups"""
|
|
169
|
+
return self.request("POST", f"/v1/payment_setups", query=None, body=body, idempotency_key=idempotency_key)
|
|
170
|
+
|
|
171
|
+
def get_return_addresses(self):
|
|
172
|
+
"""Your default return addresses (scope: read). GET /v1/return_addresses"""
|
|
173
|
+
return self.request("GET", f"/v1/return_addresses", query=None, body=None)
|
|
174
|
+
|
|
175
|
+
def post_return_addresses(self, *, body, idempotency_key=None):
|
|
176
|
+
"""Register your default return addresses (scope: write). POST /v1/return_addresses"""
|
|
177
|
+
return self.request("POST", f"/v1/return_addresses", query=None, body=body, idempotency_key=idempotency_key)
|
|
178
|
+
|
|
179
|
+
def get_bank_accounts(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
180
|
+
"""List bank accounts (scope: read). GET /v1/bank_accounts"""
|
|
181
|
+
return self.request("GET", f"/v1/bank_accounts", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
182
|
+
|
|
183
|
+
def post_bank_accounts(self, *, body, idempotency_key=None):
|
|
184
|
+
"""Link a customer's own bank account (scope: write). POST /v1/bank_accounts"""
|
|
185
|
+
return self.request("POST", f"/v1/bank_accounts", query=None, body=body, idempotency_key=idempotency_key)
|
|
186
|
+
|
|
187
|
+
def get_bank_accounts_by_id(self, id):
|
|
188
|
+
"""A bank account (scope: read). GET /v1/bank_accounts/{id}"""
|
|
189
|
+
return self.request("GET", f"/v1/bank_accounts/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
190
|
+
|
|
191
|
+
def get_cash_out_addresses(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
192
|
+
"""List Cash-Out Addresses (scope: read). GET /v1/cash_out_addresses"""
|
|
193
|
+
return self.request("GET", f"/v1/cash_out_addresses", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
194
|
+
|
|
195
|
+
def post_cash_out_addresses(self, *, body, idempotency_key=None):
|
|
196
|
+
"""Open a Cash-Out Address (scope: write). POST /v1/cash_out_addresses"""
|
|
197
|
+
return self.request("POST", f"/v1/cash_out_addresses", query=None, body=body, idempotency_key=idempotency_key)
|
|
198
|
+
|
|
199
|
+
def post_routes_quote(self, *, body, idempotency_key=None):
|
|
200
|
+
"""Every route that can turn a stablecoin into a bank payment, ranked (scope: read). POST /v1/routes/quote"""
|
|
201
|
+
return self.request("POST", f"/v1/routes/quote", query=None, body=body, idempotency_key=idempotency_key)
|
|
202
|
+
|
|
203
|
+
def post_deposit_options(self, *, body, idempotency_key=None):
|
|
204
|
+
"""Every way a customer can pay in, in one call (scope: write). POST /v1/deposit_options"""
|
|
205
|
+
return self.request("POST", f"/v1/deposit_options", query=None, body=body, idempotency_key=idempotency_key)
|
|
206
|
+
|
|
207
|
+
def get_cash_out_addresses_by_id(self, id):
|
|
208
|
+
"""A Cash-Out Address (scope: read). GET /v1/cash_out_addresses/{id}"""
|
|
209
|
+
return self.request("GET", f"/v1/cash_out_addresses/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
210
|
+
|
|
211
|
+
def post_cash_out_addresses_by_id(self, id, *, body, idempotency_key=None):
|
|
212
|
+
"""Pay another of the customer's banks (scope: write). POST /v1/cash_out_addresses/{id}"""
|
|
213
|
+
return self.request("POST", f"/v1/cash_out_addresses/{urllib.parse.quote(str(id), safe='')}", query=None, body=body, idempotency_key=idempotency_key)
|
|
214
|
+
|
|
215
|
+
def get_cash_out_payments(self, *, customer=None, cash_out_address=None, created_since=None, limit=None, created_before=None, starting_after=None):
|
|
216
|
+
"""Payments into Cash-Out Addresses (scope: read). GET /v1/cash_out_payments"""
|
|
217
|
+
return self.request("GET", f"/v1/cash_out_payments", query={"customer": customer, "cashOutAddress": cash_out_address, "createdSince": created_since, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
218
|
+
|
|
219
|
+
def get_cash_out_payments_by_id(self, id):
|
|
220
|
+
"""A Cash-Out payment (scope: read). GET /v1/cash_out_payments/{id}"""
|
|
221
|
+
return self.request("GET", f"/v1/cash_out_payments/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
222
|
+
|
|
223
|
+
def post_cash_out_payments_by_id_execute_trade(self, id, *, idempotency_key=None):
|
|
224
|
+
"""Execute this payment's pending USDT trade (deprecated) (scope: write). POST /v1/cash_out_payments/{id}/execute_trade"""
|
|
225
|
+
return self.request("POST", f"/v1/cash_out_payments/{urllib.parse.quote(str(id), safe='')}/execute_trade", query=None, body=None, idempotency_key=idempotency_key)
|
|
226
|
+
|
|
227
|
+
def get_pending_trades(self):
|
|
228
|
+
"""Payments waiting on a pending USDT trade (deprecated) (scope: read). GET /v1/pending_trades"""
|
|
229
|
+
return self.request("GET", f"/v1/pending_trades", query=None, body=None)
|
|
230
|
+
|
|
231
|
+
def get_cash_out_payments_by_id_sender(self, id):
|
|
232
|
+
"""The message the paying wallet signs to prove its sender (scope: read). GET /v1/cash_out_payments/{id}/sender"""
|
|
233
|
+
return self.request("GET", f"/v1/cash_out_payments/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=None)
|
|
234
|
+
|
|
235
|
+
def post_cash_out_payments_by_id_sender(self, id, *, body, idempotency_key=None):
|
|
236
|
+
"""Who paid (Travel Rule) (scope: write). POST /v1/cash_out_payments/{id}/sender"""
|
|
237
|
+
return self.request("POST", f"/v1/cash_out_payments/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
238
|
+
|
|
239
|
+
def get_virtual_accounts(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
240
|
+
"""List virtual accounts (scope: read). GET /v1/virtual_accounts"""
|
|
241
|
+
return self.request("GET", f"/v1/virtual_accounts", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
242
|
+
|
|
243
|
+
def post_virtual_accounts(self, *, body, idempotency_key=None):
|
|
244
|
+
"""Open a virtual account (scope: write). POST /v1/virtual_accounts"""
|
|
245
|
+
return self.request("POST", f"/v1/virtual_accounts", query=None, body=body, idempotency_key=idempotency_key)
|
|
246
|
+
|
|
247
|
+
def get_virtual_accounts_by_id(self, id):
|
|
248
|
+
"""A virtual account with its deposit instructions (scope: read). GET /v1/virtual_accounts/{id}"""
|
|
249
|
+
return self.request("GET", f"/v1/virtual_accounts/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
250
|
+
|
|
251
|
+
def get_virtual_accounts_by_id_microdeposits(self, id, *, limit=None):
|
|
252
|
+
"""Verification deposits (scope: read). GET /v1/virtual_accounts/{id}/microdeposits"""
|
|
253
|
+
return self.request("GET", f"/v1/virtual_accounts/{urllib.parse.quote(str(id), safe='')}/microdeposits", query={"limit": limit}, body=None)
|
|
254
|
+
|
|
255
|
+
def post_virtual_accounts_by_id_deactivate(self, id, *, idempotency_key=None):
|
|
256
|
+
"""Deactivate (scope: write). POST /v1/virtual_accounts/{id}/deactivate"""
|
|
257
|
+
return self.request("POST", f"/v1/virtual_accounts/{urllib.parse.quote(str(id), safe='')}/deactivate", query=None, body=None, idempotency_key=idempotency_key)
|
|
258
|
+
|
|
259
|
+
def post_virtual_accounts_by_id_reactivate(self, id, *, idempotency_key=None):
|
|
260
|
+
"""Reactivate (scope: write). POST /v1/virtual_accounts/{id}/reactivate"""
|
|
261
|
+
return self.request("POST", f"/v1/virtual_accounts/{urllib.parse.quote(str(id), safe='')}/reactivate", query=None, body=None, idempotency_key=idempotency_key)
|
|
262
|
+
|
|
263
|
+
def get_deposits(self, *, customer=None, virtual_account=None, created_since=None, limit=None, created_before=None, starting_after=None):
|
|
264
|
+
"""Deposits (scope: read). GET /v1/deposits"""
|
|
265
|
+
return self.request("GET", f"/v1/deposits", query={"customer": customer, "virtualAccount": virtual_account, "createdSince": created_since, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
266
|
+
|
|
267
|
+
def get_deposits_by_id(self, id):
|
|
268
|
+
"""A deposit, with who sent it (scope: read). GET /v1/deposits/{id}"""
|
|
269
|
+
return self.request("GET", f"/v1/deposits/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
270
|
+
|
|
271
|
+
def post_deposits_by_id_sender(self, id, *, body, idempotency_key=None):
|
|
272
|
+
"""Who paid (Travel Rule) (scope: write). POST /v1/deposits/{id}/sender"""
|
|
273
|
+
return self.request("POST", f"/v1/deposits/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
274
|
+
|
|
275
|
+
def get_deposits_by_id_return(self, id):
|
|
276
|
+
"""A deposit's return, re-read from the provider (scope: read). GET /v1/deposits/{id}/return"""
|
|
277
|
+
return self.request("GET", f"/v1/deposits/{urllib.parse.quote(str(id), safe='')}/return", query=None, body=None)
|
|
278
|
+
|
|
279
|
+
def post_deposits_by_id_return(self, id, *, body, idempotency_key=None):
|
|
280
|
+
"""Send a dollar deposit back to its sender (scope: write). POST /v1/deposits/{id}/return"""
|
|
281
|
+
return self.request("POST", f"/v1/deposits/{urllib.parse.quote(str(id), safe='')}/return", query=None, body=body, idempotency_key=idempotency_key)
|
|
282
|
+
|
|
283
|
+
def get_deposit_returns(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
284
|
+
"""Deposit returns (scope: read). GET /v1/deposit_returns"""
|
|
285
|
+
return self.request("GET", f"/v1/deposit_returns", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
286
|
+
|
|
287
|
+
def get_crypto_return_policies(self):
|
|
288
|
+
"""Where the provider returns crypto it cannot deliver (scope: read). GET /v1/crypto_return_policies"""
|
|
289
|
+
return self.request("GET", f"/v1/crypto_return_policies", query=None, body=None)
|
|
290
|
+
|
|
291
|
+
def get_static_memos(self, *, customer=None, memo=None, limit=None, created_before=None, starting_after=None):
|
|
292
|
+
"""Static memos; match one by memo (scope: read). GET /v1/static_memos"""
|
|
293
|
+
return self.request("GET", f"/v1/static_memos", query={"customer": customer, "memo": memo, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
294
|
+
|
|
295
|
+
def post_static_memos(self, *, body, idempotency_key=None):
|
|
296
|
+
"""A memo on a shared USD account (scope: write). POST /v1/static_memos"""
|
|
297
|
+
return self.request("POST", f"/v1/static_memos", query=None, body=body, idempotency_key=idempotency_key)
|
|
298
|
+
|
|
299
|
+
def get_static_memos_by_id(self, id):
|
|
300
|
+
"""A static memo, with deposit instructions read from the provider (scope: read). GET /v1/static_memos/{id}"""
|
|
301
|
+
return self.request("GET", f"/v1/static_memos/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
302
|
+
|
|
303
|
+
def get_static_memos_by_id_history(self, id):
|
|
304
|
+
"""The memo's activity at the provider (scope: read). GET /v1/static_memos/{id}/history"""
|
|
305
|
+
return self.request("GET", f"/v1/static_memos/{urllib.parse.quote(str(id), safe='')}/history", query=None, body=None)
|
|
306
|
+
|
|
307
|
+
def get_static_memo_deposits(self, *, static_memo=None, memo=None, created_since=None, limit=None, created_before=None, starting_after=None):
|
|
308
|
+
"""Deposits into static memos; match by memo (scope: read). GET /v1/static_memo_deposits"""
|
|
309
|
+
return self.request("GET", f"/v1/static_memo_deposits", query={"staticMemo": static_memo, "memo": memo, "createdSince": created_since, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
310
|
+
|
|
311
|
+
def get_static_memo_deposits_by_id(self, id):
|
|
312
|
+
"""A static memo deposit (scope: read). GET /v1/static_memo_deposits/{id}"""
|
|
313
|
+
return self.request("GET", f"/v1/static_memo_deposits/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
314
|
+
|
|
315
|
+
def post_static_memo_deposits_by_id_sender(self, id, *, body, idempotency_key=None):
|
|
316
|
+
"""Who paid into a memo (Travel Rule) (scope: write). POST /v1/static_memo_deposits/{id}/sender"""
|
|
317
|
+
return self.request("POST", f"/v1/static_memo_deposits/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
318
|
+
|
|
319
|
+
def post_sandbox_static_memo_deposits(self, *, body, idempotency_key=None):
|
|
320
|
+
"""A simulated memo deposit (scope: write). POST /v1/sandbox/static_memo_deposits"""
|
|
321
|
+
return self.request("POST", f"/v1/sandbox/static_memo_deposits", query=None, body=body, idempotency_key=idempotency_key)
|
|
322
|
+
|
|
323
|
+
def get_static_templates(self, *, customer=None, memo=None, limit=None, created_before=None, starting_after=None):
|
|
324
|
+
"""Static templates; match one by memo (scope: read). GET /v1/static_templates"""
|
|
325
|
+
return self.request("GET", f"/v1/static_templates", query={"customer": customer, "memo": memo, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
326
|
+
|
|
327
|
+
def post_static_templates(self, *, body, idempotency_key=None):
|
|
328
|
+
"""Standing deposit instructions with a reference (the provider's successor to static memos) (scope: write). POST /v1/static_templates"""
|
|
329
|
+
return self.request("POST", f"/v1/static_templates", query=None, body=body, idempotency_key=idempotency_key)
|
|
330
|
+
|
|
331
|
+
def get_static_templates_by_id(self, id):
|
|
332
|
+
"""A static template, with deposit instructions read from the provider (scope: read). GET /v1/static_templates/{id}"""
|
|
333
|
+
return self.request("GET", f"/v1/static_templates/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
334
|
+
|
|
335
|
+
def post_static_templates_by_id_cancel(self, id, *, idempotency_key=None):
|
|
336
|
+
"""Cancel a static template (scope: write). POST /v1/static_templates/{id}/cancel"""
|
|
337
|
+
return self.request("POST", f"/v1/static_templates/{urllib.parse.quote(str(id), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
338
|
+
|
|
339
|
+
def get_static_template_transfers(self, *, static_template=None, memo=None, created_since=None, limit=None, created_before=None, starting_after=None):
|
|
340
|
+
"""Payments into static templates; match by memo (scope: read). GET /v1/static_template_transfers"""
|
|
341
|
+
return self.request("GET", f"/v1/static_template_transfers", query={"staticTemplate": static_template, "memo": memo, "createdSince": created_since, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
342
|
+
|
|
343
|
+
def get_static_template_transfers_by_id(self, id):
|
|
344
|
+
"""A payment into a static template (scope: read). GET /v1/static_template_transfers/{id}"""
|
|
345
|
+
return self.request("GET", f"/v1/static_template_transfers/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
346
|
+
|
|
347
|
+
def post_static_template_transfers_by_id_sender(self, id, *, body, idempotency_key=None):
|
|
348
|
+
"""Who paid into a template (Travel Rule) (scope: write). POST /v1/static_template_transfers/{id}/sender"""
|
|
349
|
+
return self.request("POST", f"/v1/static_template_transfers/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
350
|
+
|
|
351
|
+
def post_sandbox_static_template_transfers(self, *, body, idempotency_key=None):
|
|
352
|
+
"""A simulated template payment (scope: write). POST /v1/sandbox/static_template_transfers"""
|
|
353
|
+
return self.request("POST", f"/v1/sandbox/static_template_transfers", query=None, body=body, idempotency_key=idempotency_key)
|
|
354
|
+
|
|
355
|
+
def get_cop_payins(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
356
|
+
"""COP payments by bank transfer (scope: read). GET /v1/cop_payins"""
|
|
357
|
+
return self.request("GET", f"/v1/cop_payins", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
358
|
+
|
|
359
|
+
def post_cop_payins(self, *, body, idempotency_key=None):
|
|
360
|
+
"""A COP payment by Colombian bank transfer (PSE) (scope: write). POST /v1/cop_payins"""
|
|
361
|
+
return self.request("POST", f"/v1/cop_payins", query=None, body=body, idempotency_key=idempotency_key)
|
|
362
|
+
|
|
363
|
+
def get_cop_payins_by_id(self, id):
|
|
364
|
+
"""A COP payment, re-read from the provider (scope: read). GET /v1/cop_payins/{id}"""
|
|
365
|
+
return self.request("GET", f"/v1/cop_payins/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
366
|
+
|
|
367
|
+
def get_payers(self, *, limit=None, created_before=None, starting_after=None):
|
|
368
|
+
"""Saved payers (scope: read). GET /v1/payers"""
|
|
369
|
+
return self.request("GET", f"/v1/payers", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
370
|
+
|
|
371
|
+
def post_payers(self, *, body, idempotency_key=None):
|
|
372
|
+
"""Save a payer (scope: write). POST /v1/payers"""
|
|
373
|
+
return self.request("POST", f"/v1/payers", query=None, body=body, idempotency_key=idempotency_key)
|
|
374
|
+
|
|
375
|
+
def delete_payers_by_payer(self, payer):
|
|
376
|
+
"""Forget a payer (scope: write). DELETE /v1/payers/{payer}"""
|
|
377
|
+
return self.request("DELETE", f"/v1/payers/{urllib.parse.quote(str(payer), safe='')}", query=None, body=None)
|
|
378
|
+
|
|
379
|
+
def get_conversion_routes(self):
|
|
380
|
+
"""Allowed crypto-to-crypto routes (scope: read). GET /v1/conversion_routes"""
|
|
381
|
+
return self.request("GET", f"/v1/conversion_routes", query=None, body=None)
|
|
382
|
+
|
|
383
|
+
def get_conversion_addresses(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
384
|
+
"""List Conversion Addresses (scope: read). GET /v1/conversion_addresses"""
|
|
385
|
+
return self.request("GET", f"/v1/conversion_addresses", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
386
|
+
|
|
387
|
+
def post_conversion_addresses(self, *, body, idempotency_key=None):
|
|
388
|
+
"""Open a Conversion Address (scope: write). POST /v1/conversion_addresses"""
|
|
389
|
+
return self.request("POST", f"/v1/conversion_addresses", query=None, body=body, idempotency_key=idempotency_key)
|
|
390
|
+
|
|
391
|
+
def get_conversion_addresses_by_id(self, id):
|
|
392
|
+
"""A Conversion Address (scope: read). GET /v1/conversion_addresses/{id}"""
|
|
393
|
+
return self.request("GET", f"/v1/conversion_addresses/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
394
|
+
|
|
395
|
+
def get_conversion_payments(self, *, limit=None, created_before=None, starting_after=None):
|
|
396
|
+
"""Conversion payments (scope: read). GET /v1/conversion_payments"""
|
|
397
|
+
return self.request("GET", f"/v1/conversion_payments", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
398
|
+
|
|
399
|
+
def get_conversion_payments_by_id(self, id):
|
|
400
|
+
"""A Conversion payment (scope: read). GET /v1/conversion_payments/{id}"""
|
|
401
|
+
return self.request("GET", f"/v1/conversion_payments/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
402
|
+
|
|
403
|
+
def get_conversion_payments_by_id_sender(self, id):
|
|
404
|
+
"""The message the paying wallet signs to prove its sender (scope: read). GET /v1/conversion_payments/{id}/sender"""
|
|
405
|
+
return self.request("GET", f"/v1/conversion_payments/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=None)
|
|
406
|
+
|
|
407
|
+
def post_conversion_payments_by_id_sender(self, id, *, body, idempotency_key=None):
|
|
408
|
+
"""Who paid (Travel Rule) (scope: write). POST /v1/conversion_payments/{id}/sender"""
|
|
409
|
+
return self.request("POST", f"/v1/conversion_payments/{urllib.parse.quote(str(id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
410
|
+
|
|
411
|
+
def get_wallets(self, *, customer=None, custody=None, limit=None, created_before=None, starting_after=None):
|
|
412
|
+
"""List wallets (scope: read). GET /v1/wallets"""
|
|
413
|
+
return self.request("GET", f"/v1/wallets", query={"customer": customer, "custody": custody, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
414
|
+
|
|
415
|
+
def post_wallets(self, *, body, idempotency_key=None):
|
|
416
|
+
"""Open a wallet: custodial (the provider holds it) or self-custody (your own people and keys hold it) (scope: write). POST /v1/wallets"""
|
|
417
|
+
return self.request("POST", f"/v1/wallets", query=None, body=body, idempotency_key=idempotency_key)
|
|
418
|
+
|
|
419
|
+
def get_wallets_owner_candidates(self):
|
|
420
|
+
"""Who may own a self-custody wallet (scope: read). GET /v1/wallets/owner_candidates"""
|
|
421
|
+
return self.request("GET", f"/v1/wallets/owner_candidates", query=None, body=None)
|
|
422
|
+
|
|
423
|
+
def get_wallets_by_id_payments(self, id):
|
|
424
|
+
"""A self-custody wallet's payments (scope: read). GET /v1/wallets/{id}/payments"""
|
|
425
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/payments", query=None, body=None)
|
|
426
|
+
|
|
427
|
+
def post_wallets_by_id_payments(self, id, *, body, idempotency_key=None):
|
|
428
|
+
"""Pay from a self-custody wallet: SET checks, then proposes (scope: write). POST /v1/wallets/{id}/payments"""
|
|
429
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/payments", query=None, body=body, idempotency_key=idempotency_key)
|
|
430
|
+
|
|
431
|
+
def get_wallets_by_id_payments_by_payment(self, id, payment):
|
|
432
|
+
"""One payment, re-read from the provider (scope: read). GET /v1/wallets/{id}/payments/{payment}"""
|
|
433
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/payments/{urllib.parse.quote(str(payment), safe='')}", query=None, body=None)
|
|
434
|
+
|
|
435
|
+
def post_wallets_by_id_payments_by_payment_signatures(self, id, payment, *, body, idempotency_key=None):
|
|
436
|
+
"""Post an owner's signature (scope: approve). POST /v1/wallets/{id}/payments/{payment}/signatures"""
|
|
437
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/payments/{urllib.parse.quote(str(payment), safe='')}/signatures", query=None, body=body, idempotency_key=idempotency_key)
|
|
438
|
+
|
|
439
|
+
def post_wallets_by_id_acceptance(self, id, *, idempotency_key=None):
|
|
440
|
+
"""Accept ownership of a self-custody wallet (scope: approve). POST /v1/wallets/{id}/acceptance"""
|
|
441
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/acceptance", query=None, body=None, idempotency_key=idempotency_key)
|
|
442
|
+
|
|
443
|
+
def get_wallets_by_id(self, id):
|
|
444
|
+
"""A wallet with its balances (scope: read). GET /v1/wallets/{id}"""
|
|
445
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
446
|
+
|
|
447
|
+
def get_wallets_by_id_activity(self, id):
|
|
448
|
+
"""The provider's history for the wallet (scope: read). GET /v1/wallets/{id}/activity"""
|
|
449
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/activity", query=None, body=None)
|
|
450
|
+
|
|
451
|
+
def post_wallets_by_id_activity_by_event_id_sender(self, id, event_id, *, body, idempotency_key=None):
|
|
452
|
+
"""Who sent a direct deposit (scope: write). POST /v1/wallets/{id}/activity/{eventId}/sender"""
|
|
453
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/activity/{urllib.parse.quote(str(event_id), safe='')}/sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
454
|
+
|
|
455
|
+
def get_wallets_by_id_withdrawals(self, id, *, limit=None, created_before=None, starting_after=None):
|
|
456
|
+
"""Withdrawals (scope: read). GET /v1/wallets/{id}/withdrawals"""
|
|
457
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/withdrawals", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
458
|
+
|
|
459
|
+
def post_wallets_by_id_withdrawals(self, id, *, body, idempotency_key=None):
|
|
460
|
+
"""Withdraw to the customer's own bank (scope: write). POST /v1/wallets/{id}/withdrawals"""
|
|
461
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/withdrawals", query=None, body=body, idempotency_key=idempotency_key)
|
|
462
|
+
|
|
463
|
+
def get_wallets_by_id_treasury(self, id):
|
|
464
|
+
"""Treasury rule (scope: read). GET /v1/wallets/{id}/treasury"""
|
|
465
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/treasury", query=None, body=None)
|
|
466
|
+
|
|
467
|
+
def put_wallets_by_id_treasury(self, id, *, body, idempotency_key=None):
|
|
468
|
+
"""Set the treasury rule (scope: write). PUT /v1/wallets/{id}/treasury"""
|
|
469
|
+
return self.request("PUT", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/treasury", query=None, body=body, idempotency_key=idempotency_key)
|
|
470
|
+
|
|
471
|
+
def delete_wallets_by_id_treasury(self, id):
|
|
472
|
+
"""Turn the treasury rule off (scope: write). DELETE /v1/wallets/{id}/treasury"""
|
|
473
|
+
return self.request("DELETE", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/treasury", query=None, body=None)
|
|
474
|
+
|
|
475
|
+
def post_wallets_by_id_sweeps(self, id, *, body, idempotency_key=None):
|
|
476
|
+
"""Sweep now (scope: write). POST /v1/wallets/{id}/sweeps"""
|
|
477
|
+
return self.request("POST", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/sweeps", query=None, body=body, idempotency_key=idempotency_key)
|
|
478
|
+
|
|
479
|
+
def get_recipients(self, *, customer=None, limit=None, created_before=None, starting_after=None):
|
|
480
|
+
"""List recipients (scope: read). GET /v1/recipients"""
|
|
481
|
+
return self.request("GET", f"/v1/recipients", query={"customer": customer, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
482
|
+
|
|
483
|
+
def post_recipients(self, *, body, idempotency_key=None):
|
|
484
|
+
"""Create a recipient (a third party) (scope: write). POST /v1/recipients"""
|
|
485
|
+
return self.request("POST", f"/v1/recipients", query=None, body=body, idempotency_key=idempotency_key)
|
|
486
|
+
|
|
487
|
+
def get_recipients_by_recipient(self, recipient):
|
|
488
|
+
"""A recipient (scope: read). GET /v1/recipients/{recipient}"""
|
|
489
|
+
return self.request("GET", f"/v1/recipients/{urllib.parse.quote(str(recipient), safe='')}", query=None, body=None)
|
|
490
|
+
|
|
491
|
+
def post_recipients_by_recipient_disable(self, recipient, *, idempotency_key=None):
|
|
492
|
+
"""Disable a recipient (scope: write). POST /v1/recipients/{recipient}/disable"""
|
|
493
|
+
return self.request("POST", f"/v1/recipients/{urllib.parse.quote(str(recipient), safe='')}/disable", query=None, body=None, idempotency_key=idempotency_key)
|
|
494
|
+
|
|
495
|
+
def post_recipients_by_recipient_payee_details_link(self, recipient, *, idempotency_key=None):
|
|
496
|
+
"""A link for the payee to enter their own bank details (scope: write). POST /v1/recipients/{recipient}/payee_details_link"""
|
|
497
|
+
return self.request("POST", f"/v1/recipients/{urllib.parse.quote(str(recipient), safe='')}/payee_details_link", query=None, body=None, idempotency_key=idempotency_key)
|
|
498
|
+
|
|
499
|
+
def get_payouts(self, *, wallet=None, recipient=None, batch=None, state=None, limit=None, created_before=None, starting_after=None):
|
|
500
|
+
"""List payouts (scope: read). GET /v1/payouts"""
|
|
501
|
+
return self.request("GET", f"/v1/payouts", query={"wallet": wallet, "recipient": recipient, "batch": batch, "state": state, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
502
|
+
|
|
503
|
+
def post_payouts(self, *, body, idempotency_key=None):
|
|
504
|
+
"""Pay a recipient from a custodial or self-custody wallet (scope: write). POST /v1/payouts"""
|
|
505
|
+
return self.request("POST", f"/v1/payouts", query=None, body=body, idempotency_key=idempotency_key)
|
|
506
|
+
|
|
507
|
+
def post_payouts_dry_run(self, *, body, idempotency_key=None):
|
|
508
|
+
"""Check a payout without making it (scope: write). POST /v1/payouts/dry_run"""
|
|
509
|
+
return self.request("POST", f"/v1/payouts/dry_run", query=None, body=body, idempotency_key=idempotency_key)
|
|
510
|
+
|
|
511
|
+
def get_payouts_by_payout_proof_of_payment(self, payout):
|
|
512
|
+
"""Proof of payment (scope: read). GET /v1/payouts/{payout}/proof_of_payment"""
|
|
513
|
+
return self.request("GET", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/proof_of_payment", query=None, body=None)
|
|
514
|
+
|
|
515
|
+
def get_payouts_by_payout(self, payout):
|
|
516
|
+
"""A payout (scope: read). GET /v1/payouts/{payout}"""
|
|
517
|
+
return self.request("GET", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}", query=None, body=None)
|
|
518
|
+
|
|
519
|
+
def post_payouts_by_payout_fund(self, payout, *, body, idempotency_key=None):
|
|
520
|
+
"""Top up an underfunded payout (scope: write). POST /v1/payouts/{payout}/fund"""
|
|
521
|
+
return self.request("POST", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/fund", query=None, body=body, idempotency_key=idempotency_key)
|
|
522
|
+
|
|
523
|
+
def post_payout_batches(self, *, body, idempotency_key=None):
|
|
524
|
+
"""Prefunded payouts: up to 100 from one wallet (scope: write). POST /v1/payout_batches"""
|
|
525
|
+
return self.request("POST", f"/v1/payout_batches", query=None, body=body, idempotency_key=idempotency_key)
|
|
526
|
+
|
|
527
|
+
def get_payout_batches_by_batch(self, batch):
|
|
528
|
+
"""A batch, its items and counts (scope: read). GET /v1/payout_batches/{batch}"""
|
|
529
|
+
return self.request("GET", f"/v1/payout_batches/{urllib.parse.quote(str(batch), safe='')}", query=None, body=None)
|
|
530
|
+
|
|
531
|
+
def get_transfers(self, *, customer=None, kind=None, limit=None, created_before=None, starting_after=None):
|
|
532
|
+
"""List transfers (scope: read). GET /v1/transfers"""
|
|
533
|
+
return self.request("GET", f"/v1/transfers", query={"customer": customer, "kind": kind, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
534
|
+
|
|
535
|
+
def post_transfers(self, *, body, idempotency_key=None):
|
|
536
|
+
"""A one-off transfer: a wire in to USDC, or a wallet to SWIFT (scope: write). POST /v1/transfers"""
|
|
537
|
+
return self.request("POST", f"/v1/transfers", query=None, body=body, idempotency_key=idempotency_key)
|
|
538
|
+
|
|
539
|
+
def get_transfers_by_transfer(self, transfer):
|
|
540
|
+
"""A transfer, re-read from the provider (scope: read). GET /v1/transfers/{transfer}"""
|
|
541
|
+
return self.request("GET", f"/v1/transfers/{urllib.parse.quote(str(transfer), safe='')}", query=None, body=None)
|
|
542
|
+
|
|
543
|
+
def post_transfers_by_transfer_execute(self, transfer, *, idempotency_key=None):
|
|
544
|
+
"""Execute a pending USDT trade at the market rate (deprecated) (scope: write). POST /v1/transfers/{transfer}/execute"""
|
|
545
|
+
return self.request("POST", f"/v1/transfers/{urllib.parse.quote(str(transfer), safe='')}/execute", query=None, body=None, idempotency_key=idempotency_key)
|
|
546
|
+
|
|
547
|
+
def get_funds_requests(self, *, customer=None, limit=None, starting_after=None):
|
|
548
|
+
"""Funds requests banks raised against a customer's deposits (scope: read). GET /v1/funds_requests"""
|
|
549
|
+
return self.request("GET", f"/v1/funds_requests", query={"customer": customer, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
550
|
+
|
|
551
|
+
def post_payable_emails(self, *, body, idempotency_key=None):
|
|
552
|
+
"""Where to pay this email (both account types) (scope: write). POST /v1/payable_emails"""
|
|
553
|
+
return self.request("POST", f"/v1/payable_emails", query=None, body=body, idempotency_key=idempotency_key)
|
|
554
|
+
|
|
555
|
+
def get_payable_emails_by_payee(self, payee, *, chain=None):
|
|
556
|
+
"""The payee's status now (both account types); a direct payee who chose their wallet answers destination wallet (scope: read). GET /v1/payable_emails/{payee}"""
|
|
557
|
+
return self.request("GET", f"/v1/payable_emails/{urllib.parse.quote(str(payee), safe='')}", query={"chain": chain}, body=None)
|
|
558
|
+
|
|
559
|
+
def post_payable_emails_payments(self, *, body, idempotency_key=None):
|
|
560
|
+
"""Report a payment you sent on chain from a registered sender wallet (a platform account); a payment into a wallet SET created needs SET's 0.75% fee beside it (or later, feeTxHash), else 409 set_fee_missing (scope: write). POST /v1/payable_emails/payments"""
|
|
561
|
+
return self.request("POST", f"/v1/payable_emails/payments", query=None, body=body, idempotency_key=idempotency_key)
|
|
562
|
+
|
|
563
|
+
def get_senders(self, *, limit=None, created_before=None, starting_after=None):
|
|
564
|
+
"""The wallets you pay from that SET credits to you (a platform account; a business account once SET switches business senders on) (scope: read). GET /v1/senders"""
|
|
565
|
+
return self.request("GET", f"/v1/senders", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
566
|
+
|
|
567
|
+
def post_senders(self, *, body, idempotency_key=None):
|
|
568
|
+
"""Register a wallet you pay from, with its signature (personal_sign, EIP-1271 or Solana signMessage) (scope: write). POST /v1/senders"""
|
|
569
|
+
return self.request("POST", f"/v1/senders", query=None, body=body, idempotency_key=idempotency_key)
|
|
570
|
+
|
|
571
|
+
def get_senders_message(self, *, chain=None, address=None):
|
|
572
|
+
"""The text a wallet signs to prove it is yours (scope: read). GET /v1/senders/message"""
|
|
573
|
+
return self.request("GET", f"/v1/senders/message", query={"chain": chain, "address": address}, body=None)
|
|
574
|
+
|
|
575
|
+
def delete_senders_by_chain_by_address(self, chain, address):
|
|
576
|
+
"""Remove a sender wallet (scope: write). DELETE /v1/senders/{chain}/{address}"""
|
|
577
|
+
return self.request("DELETE", f"/v1/senders/{urllib.parse.quote(str(chain), safe='')}/{urllib.parse.quote(str(address), safe='')}", query=None, body=None)
|
|
578
|
+
|
|
579
|
+
def post_payable_emails_batch(self, *, body, idempotency_key=None):
|
|
580
|
+
"""Resolve up to 20 emails as one batch, to pay with one multisend (both account types) (scope: write). POST /v1/payable_emails/batch"""
|
|
581
|
+
return self.request("POST", f"/v1/payable_emails/batch", query=None, body=body, idempotency_key=idempotency_key)
|
|
582
|
+
|
|
583
|
+
def get_payable_emails_batch_by_batch(self, batch, *, format=None):
|
|
584
|
+
"""A batch with every item's status; format=csv or format=safe for the multisend list (scope: read). GET /v1/payable_emails/batch/{batch}"""
|
|
585
|
+
return self.request("GET", f"/v1/payable_emails/batch/{urllib.parse.quote(str(batch), safe='')}", query={"format": format}, body=None)
|
|
586
|
+
|
|
587
|
+
def post_payable_emails_batch_by_batch_items(self, batch, *, body, idempotency_key=None):
|
|
588
|
+
"""Add up to 20 more emails to a batch, up to 5,000 in all (scope: write). POST /v1/payable_emails/batch/{batch}/items"""
|
|
589
|
+
return self.request("POST", f"/v1/payable_emails/batch/{urllib.parse.quote(str(batch), safe='')}/items", query=None, body=body, idempotency_key=idempotency_key)
|
|
590
|
+
|
|
591
|
+
def post_payable_emails_batch_by_batch_approve(self, batch, *, idempotency_key=None):
|
|
592
|
+
"""Approve a batch someone else asked for, while batch approval is on (the approve scope) (scope: read). POST /v1/payable_emails/batch/{batch}/approve"""
|
|
593
|
+
return self.request("POST", f"/v1/payable_emails/batch/{urllib.parse.quote(str(batch), safe='')}/approve", query=None, body=None, idempotency_key=idempotency_key)
|
|
594
|
+
|
|
595
|
+
def post_payable_emails_payments_batch(self, *, body, idempotency_key=None):
|
|
596
|
+
"""Report one multisend that paid a batch, from a registered sender wallet; payments into wallets SET created need SET's 0.75% fee (the batch's set_fee line, or later with feeTxHash), else 409 set_fee_missing; a repeat answers what is already recorded (scope: write). POST /v1/payable_emails/payments/batch"""
|
|
597
|
+
return self.request("POST", f"/v1/payable_emails/payments/batch", query=None, body=body, idempotency_key=idempotency_key)
|
|
598
|
+
|
|
599
|
+
def get_payment_references(self, *, customer=None, state=None, cash_out_address=None, cash_out_payment=None, limit=None, created_before=None, starting_after=None):
|
|
600
|
+
"""List payment references (scope: read). GET /v1/payment_references"""
|
|
601
|
+
return self.request("GET", f"/v1/payment_references", query={"customer": customer, "state": state, "cashOutAddress": cash_out_address, "cashOutPayment": cash_out_payment, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
602
|
+
|
|
603
|
+
def post_payment_references(self, *, body, idempotency_key=None):
|
|
604
|
+
"""Reserve an order's payable amount on a Cash-Out Address (a platform account) (scope: write). POST /v1/payment_references"""
|
|
605
|
+
return self.request("POST", f"/v1/payment_references", query=None, body=body, idempotency_key=idempotency_key)
|
|
606
|
+
|
|
607
|
+
def get_payment_references_by_id(self, id):
|
|
608
|
+
"""A payment reference (scope: read). GET /v1/payment_references/{id}"""
|
|
609
|
+
return self.request("GET", f"/v1/payment_references/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
610
|
+
|
|
611
|
+
def post_payment_references_by_id_cancel(self, id, *, idempotency_key=None):
|
|
612
|
+
"""Cancel an open reference (scope: write). POST /v1/payment_references/{id}/cancel"""
|
|
613
|
+
return self.request("POST", f"/v1/payment_references/{urllib.parse.quote(str(id), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
614
|
+
|
|
615
|
+
def post_payment_references_by_id_match(self, id, *, body, idempotency_key=None):
|
|
616
|
+
"""Settle a reference with a Cash-Out payment by hand (scope: write). POST /v1/payment_references/{id}/match"""
|
|
617
|
+
return self.request("POST", f"/v1/payment_references/{urllib.parse.quote(str(id), safe='')}/match", query=None, body=body, idempotency_key=idempotency_key)
|
|
618
|
+
|
|
619
|
+
def get_invoices(self, *, limit=None, created_before=None, starting_after=None):
|
|
620
|
+
"""List invoices (scope: read). GET /v1/invoices"""
|
|
621
|
+
return self.request("GET", f"/v1/invoices", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
622
|
+
|
|
623
|
+
def post_invoices(self, *, body, idempotency_key=None):
|
|
624
|
+
"""Create an invoice (a business account; a platform account for one of its customers once SET switches platform invoices on) (scope: write). POST /v1/invoices"""
|
|
625
|
+
return self.request("POST", f"/v1/invoices", query=None, body=body, idempotency_key=idempotency_key)
|
|
626
|
+
|
|
627
|
+
def get_invoices_by_invoice(self, invoice):
|
|
628
|
+
"""An invoice (scope: read). GET /v1/invoices/{invoice}"""
|
|
629
|
+
return self.request("GET", f"/v1/invoices/{urllib.parse.quote(str(invoice), safe='')}", query=None, body=None)
|
|
630
|
+
|
|
631
|
+
def post_invoices_by_invoice_void(self, invoice, *, idempotency_key=None):
|
|
632
|
+
"""Void an invoice (scope: write). POST /v1/invoices/{invoice}/void"""
|
|
633
|
+
return self.request("POST", f"/v1/invoices/{urllib.parse.quote(str(invoice), safe='')}/void", query=None, body=None, idempotency_key=idempotency_key)
|
|
634
|
+
|
|
635
|
+
def post_invoices_by_invoice_payment_claims(self, invoice, *, body, idempotency_key=None):
|
|
636
|
+
"""The payer's claim of a payment (scope: write). POST /v1/invoices/{invoice}/payment_claims"""
|
|
637
|
+
return self.request("POST", f"/v1/invoices/{urllib.parse.quote(str(invoice), safe='')}/payment_claims", query=None, body=body, idempotency_key=idempotency_key)
|
|
638
|
+
|
|
639
|
+
def get_payments(self, *, limit=None, created_before=None, starting_after=None):
|
|
640
|
+
"""Payments to match (scope: read). GET /v1/payments"""
|
|
641
|
+
return self.request("GET", f"/v1/payments", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
642
|
+
|
|
643
|
+
def post_payments_by_id_match(self, id, *, body, idempotency_key=None):
|
|
644
|
+
"""Match a payment to an invoice (scope: write). POST /v1/payments/{id}/match"""
|
|
645
|
+
return self.request("POST", f"/v1/payments/{urllib.parse.quote(str(id), safe='')}/match", query=None, body=body, idempotency_key=idempotency_key)
|
|
646
|
+
|
|
647
|
+
def get_journal_entries(self, *, customer=None, after=None, limit=None, starting_after=None):
|
|
648
|
+
"""Journal entries (scope: read). GET /v1/journal_entries"""
|
|
649
|
+
return self.request("GET", f"/v1/journal_entries", query={"customer": customer, "after": after, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
650
|
+
|
|
651
|
+
def get_journal_entries_export(self, *, month=None, format=None, customer=None):
|
|
652
|
+
"""Export (CSV, JSON, QuickBooks Online) (scope: read). GET /v1/journal_entries/export"""
|
|
653
|
+
return self.request("GET", f"/v1/journal_entries/export", query={"month": month, "format": format, "customer": customer}, body=None)
|
|
654
|
+
|
|
655
|
+
def get_ledger_mapping(self):
|
|
656
|
+
"""Ledger account mapping (scope: read). GET /v1/ledger_mapping"""
|
|
657
|
+
return self.request("GET", f"/v1/ledger_mapping", query=None, body=None)
|
|
658
|
+
|
|
659
|
+
def put_ledger_mapping(self, *, body, idempotency_key=None):
|
|
660
|
+
"""Set the ledger account mapping (scope: write). PUT /v1/ledger_mapping"""
|
|
661
|
+
return self.request("PUT", f"/v1/ledger_mapping", query=None, body=body, idempotency_key=idempotency_key)
|
|
662
|
+
|
|
663
|
+
def post_card_checkouts(self, *, body, idempotency_key=None):
|
|
664
|
+
"""A Stripe-hosted Checkout (SET Connect, a business account) (scope: write). POST /v1/card_checkouts"""
|
|
665
|
+
return self.request("POST", f"/v1/card_checkouts", query=None, body=body, idempotency_key=idempotency_key)
|
|
666
|
+
|
|
667
|
+
def get_payment_links(self, *, limit=None, created_before=None, starting_after=None):
|
|
668
|
+
"""Payment links (scope: read). GET /v1/payment_links"""
|
|
669
|
+
return self.request("GET", f"/v1/payment_links", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
670
|
+
|
|
671
|
+
def post_payment_links(self, *, body, idempotency_key=None):
|
|
672
|
+
"""A payment link for a fixed amount or an invoice (a business account) (scope: write). POST /v1/payment_links"""
|
|
673
|
+
return self.request("POST", f"/v1/payment_links", query=None, body=body, idempotency_key=idempotency_key)
|
|
674
|
+
|
|
675
|
+
def get_payment_links_by_link(self, link):
|
|
676
|
+
"""A payment link (scope: read). GET /v1/payment_links/{link}"""
|
|
677
|
+
return self.request("GET", f"/v1/payment_links/{urllib.parse.quote(str(link), safe='')}", query=None, body=None)
|
|
678
|
+
|
|
679
|
+
def post_payment_links_by_link_deactivate(self, link, *, idempotency_key=None):
|
|
680
|
+
"""Deactivate a payment link (scope: write). POST /v1/payment_links/{link}/deactivate"""
|
|
681
|
+
return self.request("POST", f"/v1/payment_links/{urllib.parse.quote(str(link), safe='')}/deactivate", query=None, body=None, idempotency_key=idempotency_key)
|
|
682
|
+
|
|
683
|
+
def get_refunds(self, *, payment=None, limit=None, created_before=None, starting_after=None):
|
|
684
|
+
"""Refunds (scope: read). GET /v1/refunds"""
|
|
685
|
+
return self.request("GET", f"/v1/refunds", query={"payment": payment, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
686
|
+
|
|
687
|
+
def post_refunds(self, *, body, idempotency_key=None):
|
|
688
|
+
"""Refund a bank or stablecoin payment (a payout to the payer) (scope: write). POST /v1/refunds"""
|
|
689
|
+
return self.request("POST", f"/v1/refunds", query=None, body=body, idempotency_key=idempotency_key)
|
|
690
|
+
|
|
691
|
+
def get_refunds_by_refund(self, refund):
|
|
692
|
+
"""A refund (scope: read). GET /v1/refunds/{refund}"""
|
|
693
|
+
return self.request("GET", f"/v1/refunds/{urllib.parse.quote(str(refund), safe='')}", query=None, body=None)
|
|
694
|
+
|
|
695
|
+
def get_invoice_schedules(self, *, limit=None, created_before=None, starting_after=None):
|
|
696
|
+
"""Recurring invoices (scope: read). GET /v1/invoice_schedules"""
|
|
697
|
+
return self.request("GET", f"/v1/invoice_schedules", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
698
|
+
|
|
699
|
+
def post_invoice_schedules(self, *, body, idempotency_key=None):
|
|
700
|
+
"""A recurring invoice (scope: write). POST /v1/invoice_schedules"""
|
|
701
|
+
return self.request("POST", f"/v1/invoice_schedules", query=None, body=body, idempotency_key=idempotency_key)
|
|
702
|
+
|
|
703
|
+
def get_invoice_schedules_by_schedule(self, schedule):
|
|
704
|
+
"""A recurring invoice (scope: read). GET /v1/invoice_schedules/{schedule}"""
|
|
705
|
+
return self.request("GET", f"/v1/invoice_schedules/{urllib.parse.quote(str(schedule), safe='')}", query=None, body=None)
|
|
706
|
+
|
|
707
|
+
def post_invoice_schedules_by_schedule_cancel(self, schedule, *, idempotency_key=None):
|
|
708
|
+
"""Cancel a recurring invoice (scope: write). POST /v1/invoice_schedules/{schedule}/cancel"""
|
|
709
|
+
return self.request("POST", f"/v1/invoice_schedules/{urllib.parse.quote(str(schedule), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
710
|
+
|
|
711
|
+
def get_card_payments(self, *, limit=None, created_before=None, starting_after=None):
|
|
712
|
+
"""Card payments (scope: read). GET /v1/card_payments"""
|
|
713
|
+
return self.request("GET", f"/v1/card_payments", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
714
|
+
|
|
715
|
+
def get_card_payments_by_card_payment(self, card_payment):
|
|
716
|
+
"""A card payment (scope: read). GET /v1/card_payments/{cardPayment}"""
|
|
717
|
+
return self.request("GET", f"/v1/card_payments/{urllib.parse.quote(str(card_payment), safe='')}", query=None, body=None)
|
|
718
|
+
|
|
719
|
+
def post_card_payments_by_card_payment_refunds(self, card_payment, *, body, idempotency_key=None):
|
|
720
|
+
"""Refund (scope: write). POST /v1/card_payments/{cardPayment}/refunds"""
|
|
721
|
+
return self.request("POST", f"/v1/card_payments/{urllib.parse.quote(str(card_payment), safe='')}/refunds", query=None, body=body, idempotency_key=idempotency_key)
|
|
722
|
+
|
|
723
|
+
def get_accounting_connections(self):
|
|
724
|
+
"""The connected ledger and its sync counts (scope: read). GET /v1/accounting/connections"""
|
|
725
|
+
return self.request("GET", f"/v1/accounting/connections", query=None, body=None)
|
|
726
|
+
|
|
727
|
+
def post_accounting_connections(self, *, body, idempotency_key=None):
|
|
728
|
+
"""Connect QuickBooks Online or Xero (scope: write). POST /v1/accounting/connections"""
|
|
729
|
+
return self.request("POST", f"/v1/accounting/connections", query=None, body=body, idempotency_key=idempotency_key)
|
|
730
|
+
|
|
731
|
+
def delete_accounting_connections(self):
|
|
732
|
+
"""Disconnect and revoke SET's access (scope: write). DELETE /v1/accounting/connections"""
|
|
733
|
+
return self.request("DELETE", f"/v1/accounting/connections", query=None, body=None)
|
|
734
|
+
|
|
735
|
+
def post_accounting_sync(self, *, idempotency_key=None):
|
|
736
|
+
"""Post entries now (at most 25) (scope: write). POST /v1/accounting/sync"""
|
|
737
|
+
return self.request("POST", f"/v1/accounting/sync", query=None, body=None, idempotency_key=idempotency_key)
|
|
738
|
+
|
|
739
|
+
def get_accounting_entries(self, *, state=None):
|
|
740
|
+
"""Each entry's post: posted, failed or skipped (scope: read). GET /v1/accounting/entries"""
|
|
741
|
+
return self.request("GET", f"/v1/accounting/entries", query={"state": state}, body=None)
|
|
742
|
+
|
|
743
|
+
def post_accounting_entries_by_entry_retry(self, entry, *, idempotency_key=None):
|
|
744
|
+
"""Queue a failed or skipped entry for the next sync (scope: write). POST /v1/accounting/entries/{entry}/retry"""
|
|
745
|
+
return self.request("POST", f"/v1/accounting/entries/{urllib.parse.quote(str(entry), safe='')}/retry", query=None, body=None, idempotency_key=idempotency_key)
|
|
746
|
+
|
|
747
|
+
def get_close_settings(self):
|
|
748
|
+
"""Close settings: first period, when entries post, today's writes (scope: read). GET /v1/close/settings"""
|
|
749
|
+
return self.request("GET", f"/v1/close/settings", query=None, body=None)
|
|
750
|
+
|
|
751
|
+
def put_close_settings(self, *, body, idempotency_key=None):
|
|
752
|
+
"""Set the first period or when entries post (scope: write). PUT /v1/close/settings"""
|
|
753
|
+
return self.request("PUT", f"/v1/close/settings", query=None, body=body, idempotency_key=idempotency_key)
|
|
754
|
+
|
|
755
|
+
def get_close_sources(self, *, created_before=None, limit=None, starting_after=None):
|
|
756
|
+
"""Record sources: SET's ledger and labelled files (scope: read). GET /v1/close/sources"""
|
|
757
|
+
return self.request("GET", f"/v1/close/sources", query={"createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
758
|
+
|
|
759
|
+
def post_close_sources(self, *, body, idempotency_key=None):
|
|
760
|
+
"""Add a bank or provider file source (scope: write). POST /v1/close/sources"""
|
|
761
|
+
return self.request("POST", f"/v1/close/sources", query=None, body=body, idempotency_key=idempotency_key)
|
|
762
|
+
|
|
763
|
+
def get_close_records(self, *, kind=None, source=None, period=None, customer=None, unmatched=None, created_before=None, limit=None, starting_after=None):
|
|
764
|
+
"""Records: each side's view of a payment, with gross, fee and net (scope: read). GET /v1/close/records"""
|
|
765
|
+
return self.request("GET", f"/v1/close/records", query={"kind": kind, "source": source, "period": period, "customer": customer, "unmatched": unmatched, "createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
766
|
+
|
|
767
|
+
def get_close_matches(self, *, period=None, state=None, rule=None, reason=None, customer=None, in_transit=None, created_before=None, limit=None, starting_after=None):
|
|
768
|
+
"""One match per payment: its records, rule and state (scope: read). GET /v1/close/matches"""
|
|
769
|
+
return self.request("GET", f"/v1/close/matches", query={"period": period, "state": state, "rule": rule, "reason": reason, "customer": customer, "inTransit": in_transit, "createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
770
|
+
|
|
771
|
+
def get_close_exceptions(self, *, reason=None, period=None, customer=None, created_before=None, limit=None, starting_after=None):
|
|
772
|
+
"""Matches in state exception, with the reason (scope: read). GET /v1/close/exceptions"""
|
|
773
|
+
return self.request("GET", f"/v1/close/exceptions", query={"reason": reason, "period": period, "customer": customer, "createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
774
|
+
|
|
775
|
+
def post_close_exceptions_by_exception_resolve(self, exception, *, body, idempotency_key=None):
|
|
776
|
+
"""Resolve an exception: link a record, ignore it, or leave it open with a note (scope: write). POST /v1/close/exceptions/{exception}/resolve"""
|
|
777
|
+
return self.request("POST", f"/v1/close/exceptions/{urllib.parse.quote(str(exception), safe='')}/resolve", query=None, body=body, idempotency_key=idempotency_key)
|
|
778
|
+
|
|
779
|
+
def get_close_periods(self):
|
|
780
|
+
"""Every period from the first, with its state and counts (scope: read). GET /v1/close/periods"""
|
|
781
|
+
return self.request("GET", f"/v1/close/periods", query=None, body=None)
|
|
782
|
+
|
|
783
|
+
def get_close_periods_by_period(self, period):
|
|
784
|
+
"""One period: state, counts, reconciling items and both hashes (scope: read). GET /v1/close/periods/{period}"""
|
|
785
|
+
return self.request("GET", f"/v1/close/periods/{urllib.parse.quote(str(period), safe='')}", query=None, body=None)
|
|
786
|
+
|
|
787
|
+
def post_close_periods_by_period_prepare(self, period, *, idempotency_key=None):
|
|
788
|
+
"""Prepare a period: open to prepared (scope: write). POST /v1/close/periods/{period}/prepare"""
|
|
789
|
+
return self.request("POST", f"/v1/close/periods/{urllib.parse.quote(str(period), safe='')}/prepare", query=None, body=None, idempotency_key=idempotency_key)
|
|
790
|
+
|
|
791
|
+
def post_close_periods_by_period_approve(self, period, *, idempotency_key=None):
|
|
792
|
+
"""Approve and lock a period (scope: approve). POST /v1/close/periods/{period}/approve"""
|
|
793
|
+
return self.request("POST", f"/v1/close/periods/{urllib.parse.quote(str(period), safe='')}/approve", query=None, body=None, idempotency_key=idempotency_key)
|
|
794
|
+
|
|
795
|
+
def get_close_periods_by_period_package(self, period, *, format=None, customer=None):
|
|
796
|
+
"""The period's package: every match, its records, compared amounts and reconciling items (scope: read). GET /v1/close/periods/{period}/package"""
|
|
797
|
+
return self.request("GET", f"/v1/close/periods/{urllib.parse.quote(str(period), safe='')}/package", query={"format": format, "customer": customer}, body=None)
|
|
798
|
+
|
|
799
|
+
def get_close_periods_by_period_verify(self, period):
|
|
800
|
+
"""Recompute a locked period's hash and its link to the prior period (scope: read). GET /v1/close/periods/{period}/verify"""
|
|
801
|
+
return self.request("GET", f"/v1/close/periods/{urllib.parse.quote(str(period), safe='')}/verify", query=None, body=None)
|
|
802
|
+
|
|
803
|
+
def post_close_sources_by_source_imports(self, source, *, id_strategy=None, filename=None, idempotency_key=None):
|
|
804
|
+
"""Upload a bank or provider CSV to a source (scope: write). POST /v1/close/sources/{source}/imports"""
|
|
805
|
+
return self.request("POST", f"/v1/close/sources/{urllib.parse.quote(str(source), safe='')}/imports", query={"idStrategy": id_strategy, "filename": filename}, body=None, idempotency_key=idempotency_key)
|
|
806
|
+
|
|
807
|
+
def get_close_issuers(self):
|
|
808
|
+
"""Every stablecoin SET knows, with its contract and issuer (scope: read). GET /v1/close/issuers"""
|
|
809
|
+
return self.request("GET", f"/v1/close/issuers", query=None, body=None)
|
|
810
|
+
|
|
811
|
+
def get_close_imports(self, *, created_before=None, limit=None, starting_after=None):
|
|
812
|
+
"""Every file uploaded, with its counts (the file itself is not kept) (scope: read). GET /v1/close/imports"""
|
|
813
|
+
return self.request("GET", f"/v1/close/imports", query={"createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
814
|
+
|
|
815
|
+
def get_close_weeks(self):
|
|
816
|
+
"""Every ISO week from Close's first, with its state and hashes (scope: read). GET /v1/close/weeks"""
|
|
817
|
+
return self.request("GET", f"/v1/close/weeks", query=None, body=None)
|
|
818
|
+
|
|
819
|
+
def get_close_weeks_by_week(self, week):
|
|
820
|
+
"""One week: state, counts now, both hashes, and whether it is final (scope: read). GET /v1/close/weeks/{week}"""
|
|
821
|
+
return self.request("GET", f"/v1/close/weeks/{urllib.parse.quote(str(week), safe='')}", query=None, body=None)
|
|
822
|
+
|
|
823
|
+
def post_close_weeks_by_week_prepare(self, week, *, idempotency_key=None):
|
|
824
|
+
"""Prepare a week: open to prepared (scope: write). POST /v1/close/weeks/{week}/prepare"""
|
|
825
|
+
return self.request("POST", f"/v1/close/weeks/{urllib.parse.quote(str(week), safe='')}/prepare", query=None, body=None, idempotency_key=idempotency_key)
|
|
826
|
+
|
|
827
|
+
def post_close_weeks_by_week_approve(self, week, *, idempotency_key=None):
|
|
828
|
+
"""Approve and sign a week (scope: approve). POST /v1/close/weeks/{week}/approve"""
|
|
829
|
+
return self.request("POST", f"/v1/close/weeks/{urllib.parse.quote(str(week), safe='')}/approve", query=None, body=None, idempotency_key=idempotency_key)
|
|
830
|
+
|
|
831
|
+
def get_close_weeks_by_week_package(self, week, *, format=None, customer=None):
|
|
832
|
+
"""The week's package: every match, its records and compared amounts (scope: read). GET /v1/close/weeks/{week}/package"""
|
|
833
|
+
return self.request("GET", f"/v1/close/weeks/{urllib.parse.quote(str(week), safe='')}/package", query={"format": format, "customer": customer}, body=None)
|
|
834
|
+
|
|
835
|
+
def get_close_weeks_by_week_verify(self, week):
|
|
836
|
+
"""Recompute a signed week's hash; name every match written since it was signed (scope: read). GET /v1/close/weeks/{week}/verify"""
|
|
837
|
+
return self.request("GET", f"/v1/close/weeks/{urllib.parse.quote(str(week), safe='')}/verify", query=None, body=None)
|
|
838
|
+
|
|
839
|
+
def get_close_quarters_by_quarter(self, quarter, *, format=None, customer=None):
|
|
840
|
+
"""A quarter (YYYY-Qn) over three locked months: counts, hashes, each month verified (scope: read). GET /v1/close/quarters/{quarter}"""
|
|
841
|
+
return self.request("GET", f"/v1/close/quarters/{urllib.parse.quote(str(quarter), safe='')}", query={"format": format, "customer": customer}, body=None)
|
|
842
|
+
|
|
843
|
+
def get_close_positions(self, *, period=None, wallet=None, state=None, created_before=None, limit=None, starting_after=None):
|
|
844
|
+
"""Position checks: a wallet's provider balance against its chain balance at a block (scope: read). GET /v1/close/positions"""
|
|
845
|
+
return self.request("GET", f"/v1/close/positions", query={"period": period, "wallet": wallet, "state": state, "createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
846
|
+
|
|
847
|
+
def post_close_positions_check(self, *, idempotency_key=None):
|
|
848
|
+
"""Check up to five of your wallets not yet checked today (scope: write). POST /v1/close/positions/check"""
|
|
849
|
+
return self.request("POST", f"/v1/close/positions/check", query=None, body=None, idempotency_key=idempotency_key)
|
|
850
|
+
|
|
851
|
+
def get_close_watched_addresses(self, *, created_before=None, limit=None, starting_after=None):
|
|
852
|
+
"""Addresses Close reads on chain for you (scope: read). GET /v1/close/watched_addresses"""
|
|
853
|
+
return self.request("GET", f"/v1/close/watched_addresses", query={"createdBefore": created_before, "limit": limit, "startingAfter": starting_after}, body=None)
|
|
854
|
+
|
|
855
|
+
def post_close_watched_addresses(self, *, body, idempotency_key=None):
|
|
856
|
+
"""Watch an address: SET reads its USDC transfers on Base or Ethereum (scope: write). POST /v1/close/watched_addresses"""
|
|
857
|
+
return self.request("POST", f"/v1/close/watched_addresses", query=None, body=body, idempotency_key=idempotency_key)
|
|
858
|
+
|
|
859
|
+
def get_close_watched_addresses_by_watch(self, watch):
|
|
860
|
+
"""One watched address, with the next block it reads (scope: read). GET /v1/close/watched_addresses/{watch}"""
|
|
861
|
+
return self.request("GET", f"/v1/close/watched_addresses/{urllib.parse.quote(str(watch), safe='')}", query=None, body=None)
|
|
862
|
+
|
|
863
|
+
def post_close_watched_addresses_by_watch_scan(self, watch, *, idempotency_key=None):
|
|
864
|
+
"""Read the next range now (scope: write). POST /v1/close/watched_addresses/{watch}/scan"""
|
|
865
|
+
return self.request("POST", f"/v1/close/watched_addresses/{urllib.parse.quote(str(watch), safe='')}/scan", query=None, body=None, idempotency_key=idempotency_key)
|
|
866
|
+
|
|
867
|
+
def post_close_watched_addresses_by_watch_stop(self, watch, *, idempotency_key=None):
|
|
868
|
+
"""Stop watching; what was recorded stays (scope: write). POST /v1/close/watched_addresses/{watch}/stop"""
|
|
869
|
+
return self.request("POST", f"/v1/close/watched_addresses/{urllib.parse.quote(str(watch), safe='')}/stop", query=None, body=None, idempotency_key=idempotency_key)
|
|
870
|
+
|
|
871
|
+
def post_close_positions_by_position_note(self, position, *, body, idempotency_key=None):
|
|
872
|
+
"""Note a balance mismatch (scope: write). POST /v1/close/positions/{position}/note"""
|
|
873
|
+
return self.request("POST", f"/v1/close/positions/{urllib.parse.quote(str(position), safe='')}/note", query=None, body=body, idempotency_key=idempotency_key)
|
|
874
|
+
|
|
875
|
+
def get_events(self, *, after=None, limit=None, type=None, created_after=None, starting_after=None):
|
|
876
|
+
"""Every event, in order (scope: read). GET /v1/events"""
|
|
877
|
+
return self.request("GET", f"/v1/events", query={"after": after, "limit": limit, "type": type, "createdAfter": created_after, "startingAfter": starting_after}, body=None)
|
|
878
|
+
|
|
879
|
+
def get_events_by_event(self, event):
|
|
880
|
+
"""One event and its delivery (scope: read). GET /v1/events/{event}"""
|
|
881
|
+
return self.request("GET", f"/v1/events/{urllib.parse.quote(str(event), safe='')}", query=None, body=None)
|
|
882
|
+
|
|
883
|
+
def post_events_by_event_redeliver(self, event, *, idempotency_key=None):
|
|
884
|
+
"""Send it again (scope: write). POST /v1/events/{event}/redeliver"""
|
|
885
|
+
return self.request("POST", f"/v1/events/{urllib.parse.quote(str(event), safe='')}/redeliver", query=None, body=None, idempotency_key=idempotency_key)
|
|
886
|
+
|
|
887
|
+
def get_events_by_event_attempts(self, event, *, endpoint=None):
|
|
888
|
+
"""Every delivery attempt, with what your server answered (scope: read). GET /v1/events/{event}/attempts"""
|
|
889
|
+
return self.request("GET", f"/v1/events/{urllib.parse.quote(str(event), safe='')}/attempts", query={"endpoint": endpoint}, body=None)
|
|
890
|
+
|
|
891
|
+
def post_webhook_test(self, *, idempotency_key=None):
|
|
892
|
+
"""A signed ping to your webhook (scope: write). POST /v1/webhook_test"""
|
|
893
|
+
return self.request("POST", f"/v1/webhook_test", query=None, body=None, idempotency_key=idempotency_key)
|
|
894
|
+
|
|
895
|
+
def get_webhook_secret(self):
|
|
896
|
+
"""Webhook URL and signing secret (before SET-Version 2026-11-13) (scope: write). GET /v1/webhook_secret"""
|
|
897
|
+
return self.request("GET", f"/v1/webhook_secret", query=None, body=None)
|
|
898
|
+
|
|
899
|
+
def get_webhook_endpoint(self):
|
|
900
|
+
"""Your webhook URL and event filter (scope: read). GET /v1/webhook_endpoint"""
|
|
901
|
+
return self.request("GET", f"/v1/webhook_endpoint", query=None, body=None)
|
|
902
|
+
|
|
903
|
+
def post_webhook_endpoint(self, *, body, idempotency_key=None):
|
|
904
|
+
"""Set your webhook URL and event filter (scope: write). POST /v1/webhook_endpoint"""
|
|
905
|
+
return self.request("POST", f"/v1/webhook_endpoint", query=None, body=body, idempotency_key=idempotency_key)
|
|
906
|
+
|
|
907
|
+
def get_webhook_endpoints(self):
|
|
908
|
+
"""Every webhook endpoint (scope: read). GET /v1/webhook_endpoints"""
|
|
909
|
+
return self.request("GET", f"/v1/webhook_endpoints", query=None, body=None)
|
|
910
|
+
|
|
911
|
+
def post_webhook_endpoints(self, *, body, idempotency_key=None):
|
|
912
|
+
"""Add a webhook endpoint (scope: write). POST /v1/webhook_endpoints"""
|
|
913
|
+
return self.request("POST", f"/v1/webhook_endpoints", query=None, body=body, idempotency_key=idempotency_key)
|
|
914
|
+
|
|
915
|
+
def get_webhook_endpoints_by_id(self, id):
|
|
916
|
+
"""One webhook endpoint, with its secret for a write key (before SET-Version 2026-11-13) (scope: read). GET /v1/webhook_endpoints/{id}"""
|
|
917
|
+
return self.request("GET", f"/v1/webhook_endpoints/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
918
|
+
|
|
919
|
+
def post_webhook_endpoints_by_id(self, id, *, body, idempotency_key=None):
|
|
920
|
+
"""Change a webhook endpoint's URL or event filter (scope: write). POST /v1/webhook_endpoints/{id}"""
|
|
921
|
+
return self.request("POST", f"/v1/webhook_endpoints/{urllib.parse.quote(str(id), safe='')}", query=None, body=body, idempotency_key=idempotency_key)
|
|
922
|
+
|
|
923
|
+
def delete_webhook_endpoints_by_id(self, id):
|
|
924
|
+
"""Delete a webhook endpoint (scope: write). DELETE /v1/webhook_endpoints/{id}"""
|
|
925
|
+
return self.request("DELETE", f"/v1/webhook_endpoints/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
926
|
+
|
|
927
|
+
def post_webhook_endpoints_by_id_rotate_secret(self, id, *, idempotency_key=None):
|
|
928
|
+
"""Rotate an endpoint's secret (scope: write). POST /v1/webhook_endpoints/{id}/rotate_secret"""
|
|
929
|
+
return self.request("POST", f"/v1/webhook_endpoints/{urllib.parse.quote(str(id), safe='')}/rotate_secret", query=None, body=None, idempotency_key=idempotency_key)
|
|
930
|
+
|
|
931
|
+
def get_kickbacks(self, *, month=None):
|
|
932
|
+
"""Your monthly fee share statements (scope: read). GET /v1/kickbacks"""
|
|
933
|
+
return self.request("GET", f"/v1/kickbacks", query={"month": month}, body=None)
|
|
934
|
+
|
|
935
|
+
def get_kickback_destination(self):
|
|
936
|
+
"""Where SET pays your fee share (scope: read). GET /v1/kickback_destination"""
|
|
937
|
+
return self.request("GET", f"/v1/kickback_destination", query=None, body=None)
|
|
938
|
+
|
|
939
|
+
def post_kickback_destination(self, *, body, idempotency_key=None):
|
|
940
|
+
"""Set where SET pays your fee share (scope: write). POST /v1/kickback_destination"""
|
|
941
|
+
return self.request("POST", f"/v1/kickback_destination", query=None, body=body, idempotency_key=idempotency_key)
|
|
942
|
+
|
|
943
|
+
def post_webhook_endpoint_rotate_secret(self, *, idempotency_key=None):
|
|
944
|
+
"""Rotate the signing secret (scope: write). POST /v1/webhook_endpoint/rotate_secret"""
|
|
945
|
+
return self.request("POST", f"/v1/webhook_endpoint/rotate_secret", query=None, body=None, idempotency_key=idempotency_key)
|
|
946
|
+
|
|
947
|
+
def get_exchange_rates(self, *, from_=None, to=None, amount=None):
|
|
948
|
+
"""The provider's current rate, and an estimate (scope: read). GET /v1/exchange_rates"""
|
|
949
|
+
return self.request("GET", f"/v1/exchange_rates", query={"from": from_, "to": to, "amount": amount}, body=None)
|
|
950
|
+
|
|
951
|
+
def get_reports_monthly(self, *, month=None):
|
|
952
|
+
"""A month's totals (scope: read). GET /v1/reports/monthly"""
|
|
953
|
+
return self.request("GET", f"/v1/reports/monthly", query={"month": month}, body=None)
|
|
954
|
+
|
|
955
|
+
def get_reports_payouts(self, *, month=None):
|
|
956
|
+
"""What reached the merchant's banks in a month (scope: read). GET /v1/reports/payouts"""
|
|
957
|
+
return self.request("GET", f"/v1/reports/payouts", query={"month": month}, body=None)
|
|
958
|
+
|
|
959
|
+
def get_reports_payout_timing(self, *, month=None):
|
|
960
|
+
"""A month's payout timing in US business days (scope: read). GET /v1/reports/payout_timing"""
|
|
961
|
+
return self.request("GET", f"/v1/reports/payout_timing", query={"month": month}, body=None)
|
|
962
|
+
|
|
963
|
+
def get_outflow_alert(self):
|
|
964
|
+
"""Your outflow alert and the last 24 hours' outflow (scope: read). GET /v1/outflow_alert"""
|
|
965
|
+
return self.request("GET", f"/v1/outflow_alert", query=None, body=None)
|
|
966
|
+
|
|
967
|
+
def post_outflow_alert(self, *, body, idempotency_key=None):
|
|
968
|
+
"""Set your outflow alert (scope: write). POST /v1/outflow_alert"""
|
|
969
|
+
return self.request("POST", f"/v1/outflow_alert", query=None, body=body, idempotency_key=idempotency_key)
|
|
970
|
+
|
|
971
|
+
def delete_outflow_alert(self):
|
|
972
|
+
"""Remove your outflow alert (scope: write). DELETE /v1/outflow_alert"""
|
|
973
|
+
return self.request("DELETE", f"/v1/outflow_alert", query=None, body=None)
|
|
974
|
+
|
|
975
|
+
def get_assets(self):
|
|
976
|
+
"""The asset register (scope: read). GET /v1/assets"""
|
|
977
|
+
return self.request("GET", f"/v1/assets", query=None, body=None)
|
|
978
|
+
|
|
979
|
+
def get_asset_policy(self):
|
|
980
|
+
"""Your asset policy (scope: read). GET /v1/asset_policy"""
|
|
981
|
+
return self.request("GET", f"/v1/asset_policy", query=None, body=None)
|
|
982
|
+
|
|
983
|
+
def post_asset_policy(self, *, body, idempotency_key=None):
|
|
984
|
+
"""Set your asset policy (scope: write). POST /v1/asset_policy"""
|
|
985
|
+
return self.request("POST", f"/v1/asset_policy", query=None, body=body, idempotency_key=idempotency_key)
|
|
986
|
+
|
|
987
|
+
def get_payouts_by_payout_travel_rule(self, payout):
|
|
988
|
+
"""Travel Rule evidence for a payout (scope: read). GET /v1/payouts/{payout}/travel_rule"""
|
|
989
|
+
return self.request("GET", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/travel_rule", query=None, body=None)
|
|
990
|
+
|
|
991
|
+
def get_deposits_by_id_travel_rule(self, id):
|
|
992
|
+
"""Travel Rule evidence for a deposit (scope: read). GET /v1/deposits/{id}/travel_rule"""
|
|
993
|
+
return self.request("GET", f"/v1/deposits/{urllib.parse.quote(str(id), safe='')}/travel_rule", query=None, body=None)
|
|
994
|
+
|
|
995
|
+
def get_cash_out_payments_by_id_travel_rule(self, id):
|
|
996
|
+
"""Travel Rule evidence for a Cash-Out payment (scope: read). GET /v1/cash_out_payments/{id}/travel_rule"""
|
|
997
|
+
return self.request("GET", f"/v1/cash_out_payments/{urllib.parse.quote(str(id), safe='')}/travel_rule", query=None, body=None)
|
|
998
|
+
|
|
999
|
+
def get_conversion_payments_by_id_travel_rule(self, id):
|
|
1000
|
+
"""Travel Rule evidence for a Conversion payment (scope: read). GET /v1/conversion_payments/{id}/travel_rule"""
|
|
1001
|
+
return self.request("GET", f"/v1/conversion_payments/{urllib.parse.quote(str(id), safe='')}/travel_rule", query=None, body=None)
|
|
1002
|
+
|
|
1003
|
+
def get_reports_settlement(self, *, date=None, type=None, format=None, starting_after=None):
|
|
1004
|
+
"""One UTC day's balance transactions, with rail references and totals (scope: read). GET /v1/reports/settlement"""
|
|
1005
|
+
return self.request("GET", f"/v1/reports/settlement", query={"date": date, "type": type, "format": format, "startingAfter": starting_after}, body=None)
|
|
1006
|
+
|
|
1007
|
+
def get_reports_reconciliation(self, *, date=None, starting_after=None):
|
|
1008
|
+
"""The daily three-way statement: ledger, bank reference and chain, per movement (scope: read). GET /v1/reports/reconciliation"""
|
|
1009
|
+
return self.request("GET", f"/v1/reports/reconciliation", query={"date": date, "startingAfter": starting_after}, body=None)
|
|
1010
|
+
|
|
1011
|
+
def get_balance_transactions(self, *, type=None, created_since=None, created_before=None, limit=None, customer=None, starting_after=None):
|
|
1012
|
+
"""Every money movement as one row, with SET's fee and the platform's share (scope: read). GET /v1/balance_transactions"""
|
|
1013
|
+
return self.request("GET", f"/v1/balance_transactions", query={"type": type, "createdSince": created_since, "createdBefore": created_before, "limit": limit, "customer": customer, "startingAfter": starting_after}, body=None)
|
|
1014
|
+
|
|
1015
|
+
def get_customers_by_customer_rewards(self, customer, *, currency=None):
|
|
1016
|
+
"""The provider's reward summary for a customer (scope: read). GET /v1/customers/{customer}/rewards"""
|
|
1017
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/rewards", query={"currency": currency}, body=None)
|
|
1018
|
+
|
|
1019
|
+
def get_customers_by_customer_rewards_history(self, customer, *, currency=None):
|
|
1020
|
+
"""The provider's daily reward history for a customer (scope: read). GET /v1/customers/{customer}/rewards/history"""
|
|
1021
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/rewards/history", query={"currency": currency}, body=None)
|
|
1022
|
+
|
|
1023
|
+
def post_customers_by_customer_cards_endorsement(self, customer, *, body, idempotency_key=None):
|
|
1024
|
+
"""The hosted link for the provider's cards endorsement (scope: write). POST /v1/customers/{customer}/cards_endorsement"""
|
|
1025
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/cards_endorsement", query=None, body=body, idempotency_key=idempotency_key)
|
|
1026
|
+
|
|
1027
|
+
def get_customers_by_customer_card_accounts(self, customer):
|
|
1028
|
+
"""The customer's card accounts (scope: read). GET /v1/customers/{customer}/card_accounts"""
|
|
1029
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts", query=None, body=None)
|
|
1030
|
+
|
|
1031
|
+
def post_customers_by_customer_card_accounts(self, customer, *, body, idempotency_key=None):
|
|
1032
|
+
"""Provision a card account (scope: write). POST /v1/customers/{customer}/card_accounts"""
|
|
1033
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts", query=None, body=body, idempotency_key=idempotency_key)
|
|
1034
|
+
|
|
1035
|
+
def get_customers_by_customer_card_accounts_by_id(self, customer, id):
|
|
1036
|
+
"""A card account, re-read from the provider (scope: read). GET /v1/customers/{customer}/card_accounts/{id}"""
|
|
1037
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1038
|
+
|
|
1039
|
+
def post_customers_by_customer_card_accounts_by_id_freeze(self, customer, id, *, body, idempotency_key=None):
|
|
1040
|
+
"""Freeze it (scope: write). POST /v1/customers/{customer}/card_accounts/{id}/freeze"""
|
|
1041
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/freeze", query=None, body=body, idempotency_key=idempotency_key)
|
|
1042
|
+
|
|
1043
|
+
def post_customers_by_customer_card_accounts_by_id_unfreeze(self, customer, id, *, body, idempotency_key=None):
|
|
1044
|
+
"""Remove a freeze (scope: write). POST /v1/customers/{customer}/card_accounts/{id}/unfreeze"""
|
|
1045
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/unfreeze", query=None, body=body, idempotency_key=idempotency_key)
|
|
1046
|
+
|
|
1047
|
+
def post_customers_by_customer_card_accounts_by_id_pin(self, customer, id, *, idempotency_key=None):
|
|
1048
|
+
"""A single-use PIN update URL (scope: write). POST /v1/customers/{customer}/card_accounts/{id}/pin"""
|
|
1049
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/pin", query=None, body=None, idempotency_key=idempotency_key)
|
|
1050
|
+
|
|
1051
|
+
def post_customers_by_customer_card_accounts_by_id_close(self, customer, id, *, body, idempotency_key=None):
|
|
1052
|
+
"""Close it, permanently (scope: write). POST /v1/customers/{customer}/card_accounts/{id}/close"""
|
|
1053
|
+
return self.request("POST", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/close", query=None, body=body, idempotency_key=idempotency_key)
|
|
1054
|
+
|
|
1055
|
+
def get_customers_by_customer_card_accounts_by_id_authorizations(self, customer, id, *, limit=None, starting_time=None, ending_time=None, status=None):
|
|
1056
|
+
"""Pending authorizations (scope: read). GET /v1/customers/{customer}/card_accounts/{id}/authorizations"""
|
|
1057
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/authorizations", query={"limit": limit, "startingTime": starting_time, "endingTime": ending_time, "status": status}, body=None)
|
|
1058
|
+
|
|
1059
|
+
def get_customers_by_customer_card_accounts_by_id_transactions(self, customer, id, *, limit=None, starting_time=None, ending_time=None, pagination_token=None, category_family=None):
|
|
1060
|
+
"""Posted transactions (scope: read). GET /v1/customers/{customer}/card_accounts/{id}/transactions"""
|
|
1061
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/transactions", query={"limit": limit, "startingTime": starting_time, "endingTime": ending_time, "paginationToken": pagination_token, "categoryFamily": category_family}, body=None)
|
|
1062
|
+
|
|
1063
|
+
def get_customers_by_customer_card_accounts_by_id_statements(self, customer, id, *, period=None):
|
|
1064
|
+
"""A month's statement (PDF) (scope: read). GET /v1/customers/{customer}/card_accounts/{id}/statements"""
|
|
1065
|
+
return self.request("GET", f"/v1/customers/{urllib.parse.quote(str(customer), safe='')}/card_accounts/{urllib.parse.quote(str(id), safe='')}/statements", query={"period": period}, body=None)
|
|
1066
|
+
|
|
1067
|
+
def post_sandbox_customers_by_customer_approve(self, customer, *, idempotency_key=None):
|
|
1068
|
+
"""Approve a test customer (scope: write). POST /v1/sandbox/customers/{customer}/approve"""
|
|
1069
|
+
return self.request("POST", f"/v1/sandbox/customers/{urllib.parse.quote(str(customer), safe='')}/approve", query=None, body=None, idempotency_key=idempotency_key)
|
|
1070
|
+
|
|
1071
|
+
def post_sandbox_deposits(self, *, body, idempotency_key=None):
|
|
1072
|
+
"""A simulated deposit (scope: write). POST /v1/sandbox/deposits"""
|
|
1073
|
+
return self.request("POST", f"/v1/sandbox/deposits", query=None, body=body, idempotency_key=idempotency_key)
|
|
1074
|
+
|
|
1075
|
+
def post_sandbox_deposits_by_sim_deposit_advance(self, sim_deposit, *, idempotency_key=None):
|
|
1076
|
+
"""Advance a simulated deposit (scope: write). POST /v1/sandbox/deposits/{simDeposit}/advance"""
|
|
1077
|
+
return self.request("POST", f"/v1/sandbox/deposits/{urllib.parse.quote(str(sim_deposit), safe='')}/advance", query=None, body=None, idempotency_key=idempotency_key)
|
|
1078
|
+
|
|
1079
|
+
def post_sandbox_cash_out_payments(self, *, body, idempotency_key=None):
|
|
1080
|
+
"""A simulated Cash-Out payment (scope: write). POST /v1/sandbox/cash_out_payments"""
|
|
1081
|
+
return self.request("POST", f"/v1/sandbox/cash_out_payments", query=None, body=body, idempotency_key=idempotency_key)
|
|
1082
|
+
|
|
1083
|
+
def post_sandbox_cash_out_payments_by_sim_drain_advance(self, sim_drain, *, idempotency_key=None):
|
|
1084
|
+
"""Advance it (scope: write). POST /v1/sandbox/cash_out_payments/{simDrain}/advance"""
|
|
1085
|
+
return self.request("POST", f"/v1/sandbox/cash_out_payments/{urllib.parse.quote(str(sim_drain), safe='')}/advance", query=None, body=None, idempotency_key=idempotency_key)
|
|
1086
|
+
|
|
1087
|
+
def post_sandbox_unknown_sender(self, *, body, idempotency_key=None):
|
|
1088
|
+
"""A simulated payment from an unknown wallet (scope: write). POST /v1/sandbox/unknown_sender"""
|
|
1089
|
+
return self.request("POST", f"/v1/sandbox/unknown_sender", query=None, body=body, idempotency_key=idempotency_key)
|
|
1090
|
+
|
|
1091
|
+
def post_sandbox_conversion_payments(self, *, body, idempotency_key=None):
|
|
1092
|
+
"""A simulated Conversion payment (scope: write). POST /v1/sandbox/conversion_payments"""
|
|
1093
|
+
return self.request("POST", f"/v1/sandbox/conversion_payments", query=None, body=body, idempotency_key=idempotency_key)
|
|
1094
|
+
|
|
1095
|
+
def post_sandbox_conversion_payments_by_sim_conversion_advance(self, sim_conversion, *, idempotency_key=None):
|
|
1096
|
+
"""Advance it (scope: write). POST /v1/sandbox/conversion_payments/{simConversion}/advance"""
|
|
1097
|
+
return self.request("POST", f"/v1/sandbox/conversion_payments/{urllib.parse.quote(str(sim_conversion), safe='')}/advance", query=None, body=None, idempotency_key=idempotency_key)
|
|
1098
|
+
|
|
1099
|
+
def post_sandbox_payouts_by_payout_advance(self, payout, *, idempotency_key=None):
|
|
1100
|
+
"""Advance a payout one step (scope: write). POST /v1/sandbox/payouts/{payout}/advance"""
|
|
1101
|
+
return self.request("POST", f"/v1/sandbox/payouts/{urllib.parse.quote(str(payout), safe='')}/advance", query=None, body=None, idempotency_key=idempotency_key)
|
|
1102
|
+
|
|
1103
|
+
def post_sandbox_scenarios(self, *, body, idempotency_key=None):
|
|
1104
|
+
"""Run one simulated outcome (scope: write). POST /v1/sandbox/scenarios"""
|
|
1105
|
+
return self.request("POST", f"/v1/sandbox/scenarios", query=None, body=body, idempotency_key=idempotency_key)
|
|
1106
|
+
|
|
1107
|
+
def post_payouts_by_payout_approve(self, payout, *, idempotency_key=None):
|
|
1108
|
+
"""Approve a payout waiting for approval (scope: approve). POST /v1/payouts/{payout}/approve"""
|
|
1109
|
+
return self.request("POST", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/approve", query=None, body=None, idempotency_key=idempotency_key)
|
|
1110
|
+
|
|
1111
|
+
def post_payouts_by_payout_reject(self, payout, *, idempotency_key=None):
|
|
1112
|
+
"""Reject a payout waiting for approval (scope: approve). POST /v1/payouts/{payout}/reject"""
|
|
1113
|
+
return self.request("POST", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/reject", query=None, body=None, idempotency_key=idempotency_key)
|
|
1114
|
+
|
|
1115
|
+
def post_payouts_by_payout_cancel(self, payout, *, idempotency_key=None):
|
|
1116
|
+
"""Cancel a payout waiting for approval or its time (scope: write). POST /v1/payouts/{payout}/cancel"""
|
|
1117
|
+
return self.request("POST", f"/v1/payouts/{urllib.parse.quote(str(payout), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
1118
|
+
|
|
1119
|
+
def get_payout_limits(self):
|
|
1120
|
+
"""The limits on your keys and recipients (scope: read). GET /v1/payout_limits"""
|
|
1121
|
+
return self.request("GET", f"/v1/payout_limits", query=None, body=None)
|
|
1122
|
+
|
|
1123
|
+
def get_payout_schedules(self, *, limit=None, created_before=None, starting_after=None):
|
|
1124
|
+
"""Recurring payouts (scope: read). GET /v1/payout_schedules"""
|
|
1125
|
+
return self.request("GET", f"/v1/payout_schedules", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1126
|
+
|
|
1127
|
+
def post_payout_schedules(self, *, body, idempotency_key=None):
|
|
1128
|
+
"""A recurring payout (scope: write). POST /v1/payout_schedules"""
|
|
1129
|
+
return self.request("POST", f"/v1/payout_schedules", query=None, body=body, idempotency_key=idempotency_key)
|
|
1130
|
+
|
|
1131
|
+
def get_payout_schedules_by_id(self, id):
|
|
1132
|
+
"""A recurring payout (scope: read). GET /v1/payout_schedules/{id}"""
|
|
1133
|
+
return self.request("GET", f"/v1/payout_schedules/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1134
|
+
|
|
1135
|
+
def delete_payout_schedules_by_id(self, id):
|
|
1136
|
+
"""Stop a recurring payout (scope: write). DELETE /v1/payout_schedules/{id}"""
|
|
1137
|
+
return self.request("DELETE", f"/v1/payout_schedules/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1138
|
+
|
|
1139
|
+
def get_metadata_by_id(self, id):
|
|
1140
|
+
"""An object's metadata (scope: read). GET /v1/metadata/{id}"""
|
|
1141
|
+
return self.request("GET", f"/v1/metadata/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1142
|
+
|
|
1143
|
+
def post_metadata_by_id(self, id, *, body, idempotency_key=None):
|
|
1144
|
+
"""Change an object's metadata (scope: write). POST /v1/metadata/{id}"""
|
|
1145
|
+
return self.request("POST", f"/v1/metadata/{urllib.parse.quote(str(id), safe='')}", query=None, body=body, idempotency_key=idempotency_key)
|
|
1146
|
+
|
|
1147
|
+
def get_restrictions(self, *, limit=None, created_before=None, starting_after=None):
|
|
1148
|
+
"""Restrictions on your business, its customers and recipients (scope: read). GET /v1/restrictions"""
|
|
1149
|
+
return self.request("GET", f"/v1/restrictions", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1150
|
+
|
|
1151
|
+
def post_restrictions(self, *, body, idempotency_key=None):
|
|
1152
|
+
"""Restrict one of your own customers, recipients or wallets (scope: write). POST /v1/restrictions"""
|
|
1153
|
+
return self.request("POST", f"/v1/restrictions", query=None, body=body, idempotency_key=idempotency_key)
|
|
1154
|
+
|
|
1155
|
+
def post_restrictions_by_restriction_lift(self, restriction, *, idempotency_key=None):
|
|
1156
|
+
"""Lift a restriction you placed (scope: write). POST /v1/restrictions/{restriction}/lift"""
|
|
1157
|
+
return self.request("POST", f"/v1/restrictions/{urllib.parse.quote(str(restriction), safe='')}/lift", query=None, body=None, idempotency_key=idempotency_key)
|
|
1158
|
+
|
|
1159
|
+
def get_data_requests(self, *, limit=None, created_before=None, starting_after=None):
|
|
1160
|
+
"""Your data-subject requests (scope: read). GET /v1/data_requests"""
|
|
1161
|
+
return self.request("GET", f"/v1/data_requests", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1162
|
+
|
|
1163
|
+
def post_data_requests(self, *, body, idempotency_key=None):
|
|
1164
|
+
"""Record a data-subject request (scope: write). POST /v1/data_requests"""
|
|
1165
|
+
return self.request("POST", f"/v1/data_requests", query=None, body=body, idempotency_key=idempotency_key)
|
|
1166
|
+
|
|
1167
|
+
def get_exports(self, *, limit=None, created_before=None, starting_after=None):
|
|
1168
|
+
"""Your exports (scope: read). GET /v1/exports"""
|
|
1169
|
+
return self.request("GET", f"/v1/exports", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1170
|
+
|
|
1171
|
+
def post_exports(self, *, idempotency_key=None):
|
|
1172
|
+
"""Export everything your business holds at SET (scope: approve). POST /v1/exports"""
|
|
1173
|
+
return self.request("POST", f"/v1/exports", query=None, body=None, idempotency_key=idempotency_key)
|
|
1174
|
+
|
|
1175
|
+
def get_exports_by_export(self, export):
|
|
1176
|
+
"""One export and its counts (scope: read). GET /v1/exports/{export}"""
|
|
1177
|
+
return self.request("GET", f"/v1/exports/{urllib.parse.quote(str(export), safe='')}", query=None, body=None)
|
|
1178
|
+
|
|
1179
|
+
def get_exports_by_export_objects(self, export, *, cursor=None, limit=None):
|
|
1180
|
+
"""An export's objects, as NDJSON (scope: read). GET /v1/exports/{export}/objects"""
|
|
1181
|
+
return self.request("GET", f"/v1/exports/{urllib.parse.quote(str(export), safe='')}/objects", query={"cursor": cursor, "limit": limit}, body=None)
|
|
1182
|
+
|
|
1183
|
+
def get_security_report(self):
|
|
1184
|
+
"""Keys, webhook endpoints and audit-log counts, from live state (scope: read). GET /v1/security_report"""
|
|
1185
|
+
return self.request("GET", f"/v1/security_report", query=None, body=None)
|
|
1186
|
+
|
|
1187
|
+
def get_audit_log(self, *, actor=None, created_before=None, limit=None, format=None, starting_after=None):
|
|
1188
|
+
"""Every write by your keys and by SET's operator for you (scope: read). GET /v1/audit_log"""
|
|
1189
|
+
return self.request("GET", f"/v1/audit_log", query={"actor": actor, "createdBefore": created_before, "limit": limit, "format": format, "startingAfter": starting_after}, body=None)
|
|
1190
|
+
|
|
1191
|
+
def get_audit_log_verify(self, *, log=None, from_seal=None):
|
|
1192
|
+
"""Verify the audit log's hash chain (scope: read). GET /v1/audit_log/verify"""
|
|
1193
|
+
return self.request("GET", f"/v1/audit_log/verify", query={"log": log, "fromSeal": from_seal}, body=None)
|
|
1194
|
+
|
|
1195
|
+
def get_statements(self, *, customer=None, month=None, limit=None, created_before=None, starting_after=None):
|
|
1196
|
+
"""List statements (scope: read). GET /v1/statements"""
|
|
1197
|
+
return self.request("GET", f"/v1/statements", query={"customer": customer, "month": month, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1198
|
+
|
|
1199
|
+
def post_statements(self, *, body, idempotency_key=None):
|
|
1200
|
+
"""Build a customer's monthly statement (scope: write). POST /v1/statements"""
|
|
1201
|
+
return self.request("POST", f"/v1/statements", query=None, body=body, idempotency_key=idempotency_key)
|
|
1202
|
+
|
|
1203
|
+
def get_statements_by_id(self, id):
|
|
1204
|
+
"""A statement: state, totals, downloads (scope: read). GET /v1/statements/{id}"""
|
|
1205
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1206
|
+
|
|
1207
|
+
def get_statements_by_id_csv(self, id):
|
|
1208
|
+
"""The statement as CSV (scope: read). GET /v1/statements/{id}/csv"""
|
|
1209
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}/csv", query=None, body=None)
|
|
1210
|
+
|
|
1211
|
+
def get_statements_by_id_pdf(self, id):
|
|
1212
|
+
"""The statement as PDF (scope: read). GET /v1/statements/{id}/pdf"""
|
|
1213
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}/pdf", query=None, body=None)
|
|
1214
|
+
|
|
1215
|
+
def get_tax_payouts(self, *, year=None, customer=None, format=None):
|
|
1216
|
+
"""A year's payouts with their verification (scope: read). GET /v1/tax/payouts"""
|
|
1217
|
+
return self.request("GET", f"/v1/tax/payouts", query={"year": year, "customer": customer, "format": format}, body=None)
|
|
1218
|
+
|
|
1219
|
+
def get_tax1099(self, *, year=None, customer=None, format=None, include=None):
|
|
1220
|
+
"""A year's payouts per customer and recipient, with the 1099 threshold (scope: read). GET /v1/tax/1099"""
|
|
1221
|
+
return self.request("GET", f"/v1/tax/1099", query={"year": year, "customer": customer, "format": format, "include": include}, body=None)
|
|
1222
|
+
|
|
1223
|
+
def get_onboarding_settings(self):
|
|
1224
|
+
"""The white-label page's frame origins and colours (scope: read). GET /v1/onboarding_settings"""
|
|
1225
|
+
return self.request("GET", f"/v1/onboarding_settings", query=None, body=None)
|
|
1226
|
+
|
|
1227
|
+
def post_onboarding_settings(self, *, body, idempotency_key=None):
|
|
1228
|
+
"""Set frame origins and colours (scope: write). POST /v1/onboarding_settings"""
|
|
1229
|
+
return self.request("POST", f"/v1/onboarding_settings", query=None, body=body, idempotency_key=idempotency_key)
|
|
1230
|
+
|
|
1231
|
+
def post_onboarding_sessions(self, *, body, idempotency_key=None):
|
|
1232
|
+
"""A white-label KYB/KYC page for one customer (scope: write). POST /v1/onboarding_sessions"""
|
|
1233
|
+
return self.request("POST", f"/v1/onboarding_sessions", query=None, body=body, idempotency_key=idempotency_key)
|
|
1234
|
+
|
|
1235
|
+
def get_onboarding_sessions_by_id(self, id):
|
|
1236
|
+
"""An onboarding session (scope: read). GET /v1/onboarding_sessions/{id}"""
|
|
1237
|
+
return self.request("GET", f"/v1/onboarding_sessions/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|
|
1238
|
+
|
|
1239
|
+
def post_onboarding_sessions_by_id_cancel(self, id, *, idempotency_key=None):
|
|
1240
|
+
"""Cancel an onboarding session (scope: write). POST /v1/onboarding_sessions/{id}/cancel"""
|
|
1241
|
+
return self.request("POST", f"/v1/onboarding_sessions/{urllib.parse.quote(str(id), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
1242
|
+
|
|
1243
|
+
def get_statements_by_id_camt054(self, id):
|
|
1244
|
+
"""The statement as ISO 20022 camt.054.001.08, one entry per bank-currency movement (scope: read). GET /v1/statements/{id}/camt054"""
|
|
1245
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}/camt054", query=None, body=None)
|
|
1246
|
+
|
|
1247
|
+
def get_statements_by_id_bai2(self, id):
|
|
1248
|
+
"""The statement as BAI2, one group per day and currency (scope: read). GET /v1/statements/{id}/bai2"""
|
|
1249
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}/bai2", query=None, body=None)
|
|
1250
|
+
|
|
1251
|
+
def get_treasury_cash_position(self, *, limit=None, created_before=None, starting_after=None):
|
|
1252
|
+
"""Where the account's money is: every wallet's balance read now, with what is pending (scope: read). GET /v1/treasury/cash_position"""
|
|
1253
|
+
return self.request("GET", f"/v1/treasury/cash_position", query={"limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1254
|
+
|
|
1255
|
+
def get_statements_by_id_camt053(self, id):
|
|
1256
|
+
"""camt.053 is not written: 409 balance_not_stated, a statement holds movements, not balances (scope: read). GET /v1/statements/{id}/camt053"""
|
|
1257
|
+
return self.request("GET", f"/v1/statements/{urllib.parse.quote(str(id), safe='')}/camt053", query=None, body=None)
|
|
1258
|
+
|
|
1259
|
+
def get_escrows(self, *, state=None, invoice=None, network=None, limit=None, created_before=None, starting_after=None):
|
|
1260
|
+
"""List escrows (scope: read). GET /v1/escrows"""
|
|
1261
|
+
return self.request("GET", f"/v1/escrows", query={"state": state, "invoice": invoice, "network": network, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1262
|
+
|
|
1263
|
+
def post_escrows(self, *, body, idempotency_key=None):
|
|
1264
|
+
"""Open a milestone escrow (scope: write). POST /v1/escrows"""
|
|
1265
|
+
return self.request("POST", f"/v1/escrows", query=None, body=body, idempotency_key=idempotency_key)
|
|
1266
|
+
|
|
1267
|
+
def get_escrows_by_escrow(self, escrow):
|
|
1268
|
+
"""Read an escrow (scope: read). GET /v1/escrows/{escrow}"""
|
|
1269
|
+
return self.request("GET", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}", query=None, body=None)
|
|
1270
|
+
|
|
1271
|
+
def post_escrows_by_escrow_accept(self, escrow, *, body, idempotency_key=None):
|
|
1272
|
+
"""Post a party's acceptance (scope: approve). POST /v1/escrows/{escrow}/accept"""
|
|
1273
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/accept", query=None, body=body, idempotency_key=idempotency_key)
|
|
1274
|
+
|
|
1275
|
+
def post_escrows_by_escrow_cancel(self, escrow, *, idempotency_key=None):
|
|
1276
|
+
"""Cancel an unfunded escrow (scope: write). POST /v1/escrows/{escrow}/cancel"""
|
|
1277
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
1278
|
+
|
|
1279
|
+
def post_escrows_by_escrow_milestones_by_milestone_submit(self, escrow, milestone, *, body, idempotency_key=None):
|
|
1280
|
+
"""Submit a milestone (scope: write). POST /v1/escrows/{escrow}/milestones/{milestone}/submit"""
|
|
1281
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/milestones/{urllib.parse.quote(str(milestone), safe='')}/submit", query=None, body=body, idempotency_key=idempotency_key)
|
|
1282
|
+
|
|
1283
|
+
def post_escrows_by_escrow_milestones_by_milestone_propose_release(self, escrow, milestone, *, body, format=None, idempotency_key=None):
|
|
1284
|
+
"""Propose a milestone's release (scope: write). POST /v1/escrows/{escrow}/milestones/{milestone}/propose_release"""
|
|
1285
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/milestones/{urllib.parse.quote(str(milestone), safe='')}/propose_release", query={"format": format}, body=body, idempotency_key=idempotency_key)
|
|
1286
|
+
|
|
1287
|
+
def post_escrows_by_escrow_signatures(self, escrow, *, body, idempotency_key=None):
|
|
1288
|
+
"""Post an owner's signature (scope: approve). POST /v1/escrows/{escrow}/signatures"""
|
|
1289
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/signatures", query=None, body=body, idempotency_key=idempotency_key)
|
|
1290
|
+
|
|
1291
|
+
def post_escrows_by_escrow_dispute(self, escrow, *, body, idempotency_key=None):
|
|
1292
|
+
"""Raise a dispute (scope: write). POST /v1/escrows/{escrow}/dispute"""
|
|
1293
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/dispute", query=None, body=body, idempotency_key=idempotency_key)
|
|
1294
|
+
|
|
1295
|
+
def post_escrows_by_escrow_propose_refund(self, escrow, *, idempotency_key=None):
|
|
1296
|
+
"""Propose a refund to the buyer (scope: write). POST /v1/escrows/{escrow}/propose_refund"""
|
|
1297
|
+
return self.request("POST", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/propose_refund", query=None, body=None, idempotency_key=idempotency_key)
|
|
1298
|
+
|
|
1299
|
+
def get_escrows_by_escrow_travel_rule(self, escrow):
|
|
1300
|
+
"""Read an escrow's Travel Rule record (scope: read). GET /v1/escrows/{escrow}/travel_rule"""
|
|
1301
|
+
return self.request("GET", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/travel_rule", query=None, body=None)
|
|
1302
|
+
|
|
1303
|
+
def get_escrows_by_escrow_safe_bundle(self, escrow, *, format=None):
|
|
1304
|
+
"""Everything to run the escrow without SET (scope: read). GET /v1/escrows/{escrow}/safe_bundle"""
|
|
1305
|
+
return self.request("GET", f"/v1/escrows/{urllib.parse.quote(str(escrow), safe='')}/safe_bundle", query={"format": format}, body=None)
|
|
1306
|
+
|
|
1307
|
+
def post_sandbox_escrows_by_escrow_fund(self, escrow, *, idempotency_key=None):
|
|
1308
|
+
"""Sandbox: fund an accepted escrow (scope: write). POST /v1/sandbox/escrows/{escrow}/fund"""
|
|
1309
|
+
return self.request("POST", f"/v1/sandbox/escrows/{urllib.parse.quote(str(escrow), safe='')}/fund", query=None, body=None, idempotency_key=idempotency_key)
|
|
1310
|
+
|
|
1311
|
+
def post_sandbox_escrows_by_escrow_milestones_by_milestone_confirm(self, escrow, milestone, *, body, idempotency_key=None):
|
|
1312
|
+
"""Sandbox: execute the ready proposal for a milestone (scope: write). POST /v1/sandbox/escrows/{escrow}/milestones/{milestone}/confirm"""
|
|
1313
|
+
return self.request("POST", f"/v1/sandbox/escrows/{urllib.parse.quote(str(escrow), safe='')}/milestones/{urllib.parse.quote(str(milestone), safe='')}/confirm", query=None, body=body, idempotency_key=idempotency_key)
|
|
1314
|
+
|
|
1315
|
+
def get_prefunding_providers(self, *, network=None):
|
|
1316
|
+
"""List prefunding providers (scope: read). GET /v1/prefunding/providers"""
|
|
1317
|
+
return self.request("GET", f"/v1/prefunding/providers", query={"network": network}, body=None)
|
|
1318
|
+
|
|
1319
|
+
def post_prefunding_quotes(self, *, body, idempotency_key=None):
|
|
1320
|
+
"""Ask a provider to quote a milestone (scope: write). POST /v1/prefunding/quotes"""
|
|
1321
|
+
return self.request("POST", f"/v1/prefunding/quotes", query=None, body=body, idempotency_key=idempotency_key)
|
|
1322
|
+
|
|
1323
|
+
def get_prefunding_advances(self, *, escrow=None, state=None, limit=None, created_before=None, starting_after=None):
|
|
1324
|
+
"""List advances (scope: read). GET /v1/prefunding/advances"""
|
|
1325
|
+
return self.request("GET", f"/v1/prefunding/advances", query={"escrow": escrow, "state": state, "limit": limit, "createdBefore": created_before, "startingAfter": starting_after}, body=None)
|
|
1326
|
+
|
|
1327
|
+
def post_prefunding_advances(self, *, body, idempotency_key=None):
|
|
1328
|
+
"""Take a quote: assign the milestone's payout (scope: write). POST /v1/prefunding/advances"""
|
|
1329
|
+
return self.request("POST", f"/v1/prefunding/advances", query=None, body=body, idempotency_key=idempotency_key)
|
|
1330
|
+
|
|
1331
|
+
def get_prefunding_advances_by_advance(self, advance):
|
|
1332
|
+
"""Read an advance (scope: read). GET /v1/prefunding/advances/{advance}"""
|
|
1333
|
+
return self.request("GET", f"/v1/prefunding/advances/{urllib.parse.quote(str(advance), safe='')}", query=None, body=None)
|
|
1334
|
+
|
|
1335
|
+
def post_prefunding_advances_by_advance_cancel(self, advance, *, idempotency_key=None):
|
|
1336
|
+
"""Cancel an advance before it is disbursed (scope: write). POST /v1/prefunding/advances/{advance}/cancel"""
|
|
1337
|
+
return self.request("POST", f"/v1/prefunding/advances/{urllib.parse.quote(str(advance), safe='')}/cancel", query=None, body=None, idempotency_key=idempotency_key)
|
|
1338
|
+
|
|
1339
|
+
def post_sandbox_prefunding_advances_by_advance_advance(self, advance, *, idempotency_key=None):
|
|
1340
|
+
"""Sandbox: the provider disburses (scope: write). POST /v1/sandbox/prefunding/advances/{advance}/advance"""
|
|
1341
|
+
return self.request("POST", f"/v1/sandbox/prefunding/advances/{urllib.parse.quote(str(advance), safe='')}/advance", query=None, body=None, idempotency_key=idempotency_key)
|
|
1342
|
+
|
|
1343
|
+
def get_wallets_by_id_recovery_bundle(self, id):
|
|
1344
|
+
"""What a self-custody wallet's owners keep to recover it (scope: read). GET /v1/wallets/{id}/recovery_bundle"""
|
|
1345
|
+
return self.request("GET", f"/v1/wallets/{urllib.parse.quote(str(id), safe='')}/recovery_bundle", query=None, body=None)
|
|
1346
|
+
|
|
1347
|
+
def post_quotes(self, *, body, idempotency_key=None):
|
|
1348
|
+
"""Quote a payout's conversion: indicative, or locked where the provider offers it (scope: read). POST /v1/quotes"""
|
|
1349
|
+
return self.request("POST", f"/v1/quotes", query=None, body=body, idempotency_key=idempotency_key)
|
|
1350
|
+
|
|
1351
|
+
def get_quotes_by_id(self, id):
|
|
1352
|
+
"""Read a quote (scope: read). GET /v1/quotes/{id}"""
|
|
1353
|
+
return self.request("GET", f"/v1/quotes/{urllib.parse.quote(str(id), safe='')}", query=None, body=None)
|