-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.txt
462 lines (426 loc) · 45 KB
/
api.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
@layeredapps/dashboard 0.0.145
http://localhost:8000
|------------------------------------------------------------------------------|
| /api/administrator/connect/delete-stripe-account |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring stripeid | boolean | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/connect/payout |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring payoutid | object | invalid-payoutid |
| | | * missing querystring payoutid |
| | | * invalid querystring payoutid |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/connect/payouts |
| RECEIVES---------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
| optional querystring accountid (string) | | |
| optional querystring stripeid (string) | | |
|------------------------------------------|----------|------------------------|
|-------------------------------------------|
| /api/administrator/connect/payouts-count |
| RETURNS-----------------------------------|
| integer |
|-------------------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/connect/person |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring personid | object | invalid-personid |
| | | * missing querystring personid |
| | | * invalid querystring personid |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/connect/persons |
| RECEIVES--------------------------------| RETURNS--| EXCEPTIONS-------------------------------| CONFIGURATION----------|
| optional querystring offset (integer) | array | invalid-stripeid | environment PAGE_SIZE |
| optional querystring limit (integer) | | * invalid Stripe account is individual | |
| optional querystring all (boolean) | | | |
| optional querystring stripeid (string) | | | |
|-----------------------------------------|----------|------------------------------------------|------------------------|
|--------------------------------------------------------------------------------------|
| /api/administrator/connect/persons-count |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-------------------------------|
| optional querystring stripeid | integer | invalid-stripe-account |
| | | * invalid Stripe account is individual |
|--------------------------------|----------|------------------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/connect/set-stripe-account-rejected |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required posted reason | boolean | invalid-stripeid |
| required querystring stripeid | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-reason |
| | | * missing posted reason |
| | | * invalid posted reason |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/connect/stripe-account |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring stripeid | object | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------------------------------------------|
| /api/administrator/connect/stripe-accounts |
| RECEIVES---------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| optional querystring offset (integer) | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | | |
| optional querystring accountid (string) | | | |
|------------------------------------------|----------|-----------------------------------|------------------------|
|---------------------------------------------------|
| /api/administrator/connect/stripe-accounts-count |
| RETURNS-------------------------------------------|
| integer |
|---------------------------------------------------|
|--------------------------------------------------------------------------------|
| /api/user/connect/country-spec |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring countryid | object | undefined |
| | | * missing querystring countryid |
| | | * invalid querystring countryid |
|---------------------------------|----------|-----------------------------------|
|----------------------------------------------------------------------------|
| /api/user/connect/country-specs |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|----------------------------------------|
| /api/user/connect/country-specs-count |
| RETURNS--------------------------------|
| integer |
|----------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------|
| /api/user/connect/create-person |
| RECEIVES-------------------------------------------| RETURNS--| EXCEPTIONS------------------------------------------------|
| required posted relationship.title | object | invalid-stripeid |
| required posted relationship.percent_ownership | | * missing querystring stripeid |
| required querystring stripeid | | * invalid querystring stripeid |
| optional posted relationship_representative | | invalid-stripe-account |
| optionally-required posted relationship_executive | | * ineligible stripe account for individuals |
| optional posted relationship_director | | * ineligible stripe account does not require directors |
| optional posted relationship_owner | | * ineligible stripe account does not require owners |
| required posted relationship_percent_ownership | | * ineligible stripe account does not require executives |
| required posted relationship_title | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-relationship_percent_ownership |
| | | * missing posted relationship.percent_ownership |
| | | * invalid posted relationship.percent_ownership |
| | | invalid-relationship_title |
| | | * missing posted relationship.title |
| | | * invalid posted relationship_title |
|----------------------------------------------------|----------|-----------------------------------------------------------|
|--------------------------------------------------------------------------------|
| /api/user/connect/create-stripe-account |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required posted business_type | object | invalid-accountid |
| required querystring accountid | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-business_type |
| | | * missing posted business_type |
| | | * invalid posted business_type |
| | | invalid-country |
| | | * invalid posted country |
| | | * invalid posted country |
|---------------------------------|----------|-----------------------------------|
|-------------------------------------------------------------------------------------------------|
| /api/user/connect/delete-person |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS------------------------------------------|
| required querystring personid | boolean | invalid-personid |
| | | * missing querystring personid |
| | | * invalid querystring personid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-person |
| | | * ineligible querystring person is representative |
|--------------------------------|----------|-----------------------------------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/delete-stripe-account |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring stripeid | boolean | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/payout |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring payoutid | object | invalid-payoutid |
| | | * missing querystring payoutid |
| | | * invalid querystring payoutid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|-----------------------------------------------------------------------------------------------------------------|
| /api/user/connect/payouts |
| RECEIVES---------------------------------| RETURNS--| EXCEPTIONS-----------------------| CONFIGURATION----------|
| required querystring payoutid | array | invalid-payoutid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring payoutid | |
| optional querystring limit (integer) | | * invalid querystring payoutid | |
| optional querystring all (boolean) | | invalid-account | |
| optional querystring stripeid (boolean) | | * ineligible accessing account | |
|------------------------------------------|----------|----------------------------------|------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/payouts-count |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring payoutid | integer | invalid-payoutid |
| | | * missing querystring payoutid |
| | | * invalid querystring payoutid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/person |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring personid | object | invalid-personid |
| | | * missing querystring personid |
| | | * invalid querystring personid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|---------------------------------------------------------------------------------------------------------------------------|
| /api/user/connect/persons |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS-----------------------------------| CONFIGURATION----------|
| required querystring stripeid | array | invalid-stripeid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring stripeid | |
| optional querystring limit (integer) | | * invalid querystring stripeid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account | |
| | | invalid-stripe-account | |
| | | * ineligible stripe account for individual | |
|----------------------------------------|----------|----------------------------------------------|------------------------|
|------------------------------------------------------------------------------------------|
| /api/user/connect/persons-count |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------------------|
| required querystring stripeid | integer | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-stripe-account |
| | | * ineligible stripe account for individual |
|--------------------------------|----------|----------------------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/user/connect/set-company-directors-submitted |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-------------------------------------|
| required querystring stripeid | object | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-stripe-account |
| | | * ineligible stripe account for individual |
| | | * ineligible company directors are submitted |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|------------------------------------------------|
|---------------------------------------------------------------------------------------------|
| /api/user/connect/set-company-executives-submitted |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required querystring stripeid | object | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-stripe-account |
| | | * ineligible stripe account for individual |
| | | * ineligible company executives are submitted |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|-------------------------------------------------|
|------------------------------------------------------------------------------------------|
| /api/user/connect/set-company-owners-submitted |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------------------|
| required querystring stripeid | object | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-stripe-account |
| | | * ineligible stripe account for individual |
| | | * ineligible company owners are submitted |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------|
| /api/user/connect/set-stripe-account-submitted |
| RECEIVES-----------------------| RETURNS--------------| EXCEPTIONS-------------------------------------------------------|
| required querystring stripeid | object (individual) | invalid-stripeid |
| | object (company) | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-stripe-account |
| | | * ineligible Stripe company account is submitted |
| | | * ineligible Stripe individual account is submitted |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-payment-details |
| | | * ineligible Stripe company account missing payment details |
| | | * ineligible Stripe individual account missing payment details |
| | | invalid-registration |
| | | * ineligible Stripe company account missing information |
| | | * ineligible Stripe individual account missing information |
| | | invalid-person |
| | | * ineligible company person missing information |
| | | invalid-company-owner |
| | | * ineligible company owners not submitted |
| | | invalid-director |
| | | * ineligible company directors not submitted |
| | | invalid-executive |
| | | * ineligible company executives not submitted |
|--------------------------------|----------------------|------------------------------------------------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/stripe-account |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring stripeid | object | invalid-stripeid |
| | | * missing querystring stripeid |
| | | * invalid querystring stripeid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|----------------------------------------------------------------------------------------------------------------|
| /api/user/connect/stripe-accounts |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account | |
|----------------------------------------|----------|-----------------------------------|------------------------|
|------------------------------------------------------------------------------|
| /api/user/connect/stripe-accounts-count |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-----------------------|
| required querystring payoutid | integer | invalid-payoutid |
| | | * missing querystring payoutid |
| | | * invalid querystring payoutid |
| | | invalid-account |
| | | * ineligible accessing account |
|--------------------------------|----------|----------------------------------|
|---------------------------------------------------------------------------------------------------------|
| /api/user/connect/update-payment-information |
| RECEIVES---------------------------------------| RETURNS--| EXCEPTIONS----------------------------------|
| required querystring routing_number | object | invalid-stripeid |
| required querystring bank_code | | * missing querystring stripeid |
| required querystring clearing_code | | * invalid querystring stripeid |
| required querystring sort_code | | invalid-account |
| required querystring transit_number | | * ineligible accessing account |
| required querystring institution_number | | invalid-account_holder_type |
| required querystring bsb_number | | * missing querystring account_holder_type |
| required querystring account_number | | * invalid querystring account_holder_type |
| required querystring iban | | invalid-currency |
| required querystring currency | | * missing querystring currency |
| required querystring account_holder_type | | * invalid querystring currency |
| required querystring stripeid | | invalid-iban |
| required posted account_holder_type | | * missing querystring iban |
| required posted currency | | * invalid querystring iban |
| optionally-required posted iban | | invalid-account_number |
| optionally-required posted account_number | | * missing querystring account_number |
| optionally-required posted bsb_number | | * invalid querystring account_number |
| optionally-required posted institution_number | | invalid-bsb_number |
| optionally-required posted transit_number | | * missing querystring bsb_number |
| optionally-required posted sort_code | | * invalid querystring bsb_number |
| optionally-required posted branch_code | | invalid-institution_number |
| optionally-required posted clearing_code | | * missing querystring institution_number |
| optionally-required posted bank_code | | * invalid querystring institution_number |
| optionally-required posted routing_number | | invalid-transit_number |
| | | * missing querystring transit_number |
| | | * invalid querystring transit_number |
| | | invalid-sort_code |
| | | * missing querystring sort_code |
| | | * invalid querystring sort_code |
| | | invalid-clearing_code |
| | | * missing querystring clearing_code |
| | | * invalid querystring clearing_code |
| | | invalid-bank_code |
| | | * missing querystring bank_code |
| | | * invalid querystring bank_code |
| | | invalid-routing_number |
| | | * missing querystring routing_number |
| | | * invalid querystring routing_number |
|------------------------------------------------|----------|---------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/user/connect/update-person |
| RECEIVES-----------------------------------------------------------| RETURNS--| EXCEPTIONS----------------------------------------------------| CONFIGURATION----------|
| required posted dob.month | object | invalid-personid | environment STRIPE_JS |
| required posted dob.month | | * missing querystring personid | |
| required posted dob.day | | * invalid querystring personid | |
| required querystring personid | | invalid-account | |
| optionally-required posted dob_day | | * ineligible accessing account | |
| optionally-required posted dob_month | | * ineligible accessing account | |
| optionally-required posted dob_year | | invalid-person | |
| optionally-required posted address_line1 | | * ineligible querystring person has no required information | |
| optionally-required posted address_city | | invalid-dob_day | |
| optionally-required posted address_state | | * missing posted dob.day | |
| optionally-required posted address_postal_code | | * invalid posted dob.day | |
| optionally-required posted email | | invalid-dob_month | |
| optionally-required posted phone | | * missing posted dob.month | |
| optionally-required posted ssn_last_4 | | * invalid posted dob.month | |
| optionally-required posted verification_document_front | | invalid-dob_year | |
| optionally-required posted verification_document_back | | * missing posted dob.month | |
| optionally-required posted verification_additional_document_front | | * invalid posted dob.month | |
| optionally-required posted verification_additional_document_back | | invalid-relationship_percent_ownership | |
| | | * invalid posted relationship.percent_ownership | |
| | | invalid-address_country | |
| | | * invalid posted address.country | |
| | | invalid-address_state | |
| | | * invalid posted address.state | |
| | | invalid-id_number | |
| | | * invalid posted id_number | |
| | | invalid-ssn_last_4 | |
| | | * invalid posted ssn_last_4 | |
| | | invalid-phone | |
| | | * invalid posted phone | |
|--------------------------------------------------------------------|----------|---------------------------------------------------------------|------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/user/connect/update-stripe-account |
| RECEIVES---------------------------------------------------------| RETURNS--| EXCEPTIONS------------------------------------| CONFIGURATION----------|
| required posted token | object | invalid-stripeid | environment STRIPE_JS |
| required posted individual_dob_month | | * missing querystring stripeid | |
| required posted individual_dob_month | | * invalid querystring stripeid | |
| required posted individual_dob_day | | invalid-account | |
| required querystring stripeid | | * ineligible accessing account | |
| optionally-required posted individual_dob_day | | invalid-stripe-account | |
| optionally-required posted individual_dob_month | | * ineligible stripe account | |
| optionally-required posted individual_dob_year | | invalid-individual_dob_day | |
| optionally-required posted individual_email | | * missing posted individual_dob_day | |
| optionally-required posted individual_phone | | * invalid posted individual_dob_day | |
| optionally-required posted individual_id_number | | invalid-individual_dob_month | |
| optionally-required posted individual_ssn_last_4 | | * missing posted individual_dob_month | |
| optionally-required posted individual_address_line1 | | * invalid posted individual_dob_month | |
| optionally-required posted individual_address_city | | invalid-individual_dob_year | |
| optionally-required posted individual_address_state | | * missing posted individual_dob_month | |
| optionally-required posted individual_address_postal_code | | * invalid posted individual_dob_month | |
| optionally-required posted individual_address_kana_line1 | | invalid-individual_address_country | |
| optionally-required posted individual_address_kana_city | | * invalid posted individual_address_country | |
| optionally-required posted individual_address_kana_town | | invalid-individual_address_state | |
| optionally-required posted individual_address_kana_state | | * invalid posted individual_address_state | |
| optionally-required posted individual_address_kana_postal_code | | invalid-individual_ssn_last_4 | |
| optionally-required posted individual_address_kanji_line1 | | * invalid posted individual_ssn_last_4 | |
| optionally-required posted individual_address_kanji_city | | invalid-individual_phone | |
| optionally-required posted individual_address_kanji_town | | * invalid posted individual_phone | |
| optionally-required posted individual_address_kanji_state | | invalid-company_address_country | |
| optionally-required posted individual_address_kanji_postal_code | | * invalid posted company_address_country | |
| optionally-required posted company_name | | invalid-company_address_state | |
| optionally-required posted company_phone | | * invalid posted company_address_state | |
| optionally-required posted company_tax_id | | invalid-company_address_kana_city | |
| optionally-required posted company_registration_number | | * invalid posted company_address_kana_city | |
| optionally-required posted company_address_line1 | | invalid-company_address_kana_town | |
| optionally-required posted company_address_city | | * invalid posted company_address_kana_town | |
| optionally-required posted company_address_state | | invalid-token | |
| optionally-required posted company_address_postal_code | | * missing posted token | |
| optionally-required posted company_address_kana_line1 | | * invalid posted token | |
| optionally-required posted company_address_kana_city | | | |
| optionally-required posted company_address_kana_town | | | |
| optionally-required posted company_address_kana_state | | | |
| optionally-required posted company_address_kana_postal_code | | | |
| optionally-required posted company_address_kanji_line1 | | | |
| optionally-required posted company_address_kanji_city | | | |
| optionally-required posted company_address_kanji_town | | | |
| optionally-required posted company_address_kanji_state | | | |
| optionally-required posted company_address_kanji_postal_code | | | |
|------------------------------------------------------------------|----------|-----------------------------------------------|------------------------|
2022-06-19T11:04:48.951Z