Update

POST

1 from mercoa import Mercoa
2 from mercoa.organization_types import OrganizationRequest
3 
4 client = Mercoa(
5     token="YOUR_TOKEN",
6 )
7 client.organization.update(
8     request=OrganizationRequest(),
9 )

Try it

200Successful

1 {
2   "id": "id",
3   "sandbox": true,
4   "name": "name",
5   "logoUrl": "logoUrl",
6   "websiteUrl": "websiteUrl",
7   "supportEmail": "supportEmail",
8   "paymentMethods": {
9     "payerPayments": [
10       {
11         "type": "bankAccount",
12         "active": true,
13         "availableDeliveryMethods": [
14           "ACH_STANDARD",
15           "ACH_STANDARD"
16         ],
17         "defaultDeliveryMethod": "ACH_STANDARD",
18         "name": "name"
19       },
20       {
21         "type": "bankAccount",
22         "active": true,
23         "availableDeliveryMethods": [
24           "ACH_STANDARD",
25           "ACH_STANDARD"
26         ],
27         "defaultDeliveryMethod": "ACH_STANDARD",
28         "name": "name"
29       }
30     ],
31     "backupDisbursements": [
32       {
33         "type": "bankAccount",
34         "active": true,
35         "availableDeliveryMethods": [
36           "ACH_STANDARD",
37           "ACH_STANDARD"
38         ],
39         "defaultDeliveryMethod": "ACH_STANDARD",
40         "name": "name"
41       },
42       {
43         "type": "bankAccount",
44         "active": true,
45         "availableDeliveryMethods": [
46           "ACH_STANDARD",
47           "ACH_STANDARD"
48         ],
49         "defaultDeliveryMethod": "ACH_STANDARD",
50         "name": "name"
51       }
52     ],
53     "vendorDisbursements": [
54       {
55         "type": "bankAccount",
56         "active": true,
57         "availableDeliveryMethods": [
58           "ACH_STANDARD",
59           "ACH_STANDARD"
60         ],
61         "defaultDeliveryMethod": "ACH_STANDARD",
62         "name": "name"
63       },
64       {
65         "type": "bankAccount",
66         "active": true,
67         "availableDeliveryMethods": [
68           "ACH_STANDARD",
69           "ACH_STANDARD"
70         ],
71         "defaultDeliveryMethod": "ACH_STANDARD",
72         "name": "name"
73       }
74     ]
75   },
76   "emailProvider": {
77     "sender": {
78       "provider": "none",
79       "fromEmail": "fromEmail",
80       "fromName": "fromName",
81       "hasApiKey": true
82     },
83     "inboxDomain": "inboxDomain",
84     "alternativeInboxDomains": [
85       "alternativeInboxDomains",
86       "alternativeInboxDomains"
87     ]
88   },
89   "externalAccountingSystemProvider": {
90     "type": "none",
91     "hasApiKey": true
92   },
93   "colorScheme": {
94     "primaryColor": "primaryColor",
95     "secondaryColor": "secondaryColor",
96     "logoBackgroundColor": "logoBackgroundColor",
97     "roundedCorners": 1,
98     "fontFamily": "fontFamily",
99     "fontSize": "fontSize"
100   },
101   "payeeOnboardingOptions": {
102     "enableBusiness": true,
103     "enableIndividual": true,
104     "paymentMethod": true,
105     "business": {
106       "address": {
107         "show": true,
108         "edit": true,
109         "required": true
110       },
111       "averageMonthlyTransactionVolume": {
112         "show": true,
113         "edit": true,
114         "required": true
115       },
116       "averageTransactionSize": {
117         "show": true,
118         "edit": true,
119         "required": true
120       },
121       "bankStatement": {
122         "show": true,
123         "edit": true,
124         "required": true
125       },
126       "description": {
127         "show": true,
128         "edit": true,
129         "required": true
130       },
131       "doingBusinessAs": {
132         "show": true,
133         "edit": true,
134         "required": true
135       },
136       "ein": {
137         "show": true,
138         "edit": true,
139         "required": true
140       },
141       "email": {
142         "show": true,
143         "edit": true,
144         "required": true
145       },
146       "formationDate": {
147         "show": true,
148         "edit": true,
149         "required": true
150       },
151       "logo": {
152         "show": true,
153         "edit": true,
154         "required": true
155       },
156       "maxTransactionSize": {
157         "show": true,
158         "edit": true,
159         "required": true
160       },
161       "mcc": {
162         "show": true,
163         "edit": true,
164         "required": true
165       },
166       "name": {
167         "show": true,
168         "edit": true,
169         "required": true
170       },
171       "phone": {
172         "show": true,
173         "edit": true,
174         "required": true
175       },
176       "representatives": {
177         "show": true,
178         "edit": true,
179         "required": true
180       },
181       "tenNinetyNine": {
182         "show": true,
183         "edit": true,
184         "required": true
185       },
186       "termsOfService": {
187         "show": true,
188         "edit": true,
189         "required": true
190       },
191       "type": {
192         "show": true,
193         "edit": true,
194         "required": true
195       },
196       "w9": {
197         "show": true,
198         "edit": true,
199         "required": true
200       },
201       "website": {
202         "show": true,
203         "edit": true,
204         "required": true
205       }
206     },
207     "individual": {
208       "address": {
209         "show": true,
210         "edit": true,
211         "required": true
212       },
213       "bankStatement": {
214         "show": true,
215         "edit": true,
216         "required": true
217       },
218       "dateOfBirth": {
219         "show": true,
220         "edit": true,
221         "required": true
222       },
223       "email": {
224         "show": true,
225         "edit": true,
226         "required": true
227       },
228       "name": {
229         "show": true,
230         "edit": true,
231         "required": true
232       },
233       "phone": {
234         "show": true,
235         "edit": true,
236         "required": true
237       },
238       "ssn": {
239         "show": true,
240         "edit": true,
241         "required": true
242       },
243       "tenNinetyNine": {
244         "show": true,
245         "edit": true,
246         "required": true
247       },
248       "termsOfService": {
249         "show": true,
250         "edit": true,
251         "required": true
252       },
253       "w9": {
254         "show": true,
255         "edit": true,
256         "required": true
257       }
258     }
259   },
260   "payorOnboardingOptions": {
261     "enableBusiness": true,
262     "enableIndividual": true,
263     "paymentMethod": true,
264     "business": {
265       "address": {
266         "show": true,
267         "edit": true,
268         "required": true
269       },
270       "averageMonthlyTransactionVolume": {
271         "show": true,
272         "edit": true,
273         "required": true
274       },
275       "averageTransactionSize": {
276         "show": true,
277         "edit": true,
278         "required": true
279       },
280       "bankStatement": {
281         "show": true,
282         "edit": true,
283         "required": true
284       },
285       "description": {
286         "show": true,
287         "edit": true,
288         "required": true
289       },
290       "doingBusinessAs": {
291         "show": true,
292         "edit": true,
293         "required": true
294       },
295       "ein": {
296         "show": true,
297         "edit": true,
298         "required": true
299       },
300       "email": {
301         "show": true,
302         "edit": true,
303         "required": true
304       },
305       "formationDate": {
306         "show": true,
307         "edit": true,
308         "required": true
309       },
310       "logo": {
311         "show": true,
312         "edit": true,
313         "required": true
314       },
315       "maxTransactionSize": {
316         "show": true,
317         "edit": true,
318         "required": true
319       },
320       "mcc": {
321         "show": true,
322         "edit": true,
323         "required": true
324       },
325       "name": {
326         "show": true,
327         "edit": true,
328         "required": true
329       },
330       "phone": {
331         "show": true,
332         "edit": true,
333         "required": true
334       },
335       "representatives": {
336         "show": true,
337         "edit": true,
338         "required": true
339       },
340       "tenNinetyNine": {
341         "show": true,
342         "edit": true,
343         "required": true
344       },
345       "termsOfService": {
346         "show": true,
347         "edit": true,
348         "required": true
349       },
350       "type": {
351         "show": true,
352         "edit": true,
353         "required": true
354       },
355       "w9": {
356         "show": true,
357         "edit": true,
358         "required": true
359       },
360       "website": {
361         "show": true,
362         "edit": true,
363         "required": true
364       }
365     },
366     "individual": {
367       "address": {
368         "show": true,
369         "edit": true,
370         "required": true
371       },
372       "bankStatement": {
373         "show": true,
374         "edit": true,
375         "required": true
376       },
377       "dateOfBirth": {
378         "show": true,
379         "edit": true,
380         "required": true
381       },
382       "email": {
383         "show": true,
384         "edit": true,
385         "required": true
386       },
387       "name": {
388         "show": true,
389         "edit": true,
390         "required": true
391       },
392       "phone": {
393         "show": true,
394         "edit": true,
395         "required": true
396       },
397       "ssn": {
398         "show": true,
399         "edit": true,
400         "required": true
401       },
402       "tenNinetyNine": {
403         "show": true,
404         "edit": true,
405         "required": true
406       },
407       "termsOfService": {
408         "show": true,
409         "edit": true,
410         "required": true
411       },
412       "w9": {
413         "show": true,
414         "edit": true,
415         "required": true
416       }
417     }
418   },
419   "metadataSchema": [
420     {
421       "key": "key",
422       "displayName": "displayName",
423       "type": "STRING",
424       "description": "description",
425       "lineItem": true,
426       "allowMultiple": true,
427       "validationRules": {
428         "type": "regex",
429         "errorMessage": "errorMessage",
430         "regex": "regex"
431       },
432       "showConditions": {
433         "alwaysHide": true,
434         "hasOptions": true,
435         "hasDocument": true,
436         "hasNoLineItems": true,
437         "paymentSourceTypes": [
438           "custom",
439           "custom"
440         ],
441         "paymentSourceCustomSchemaIds": [
442           "paymentSourceCustomSchemaIds",
443           "paymentSourceCustomSchemaIds"
444         ],
445         "paymentDestinationTypes": [
446           "custom",
447           "custom"
448         ],
449         "paymentDestinationCustomSchemaIds": [
450           "paymentDestinationCustomSchemaIds",
451           "paymentDestinationCustomSchemaIds"
452         ]
453       }
454     },
455     {
456       "key": "key",
457       "displayName": "displayName",
458       "type": "STRING",
459       "description": "description",
460       "lineItem": true,
461       "allowMultiple": true,
462       "validationRules": {
463         "type": "regex",
464         "errorMessage": "errorMessage",
465         "regex": "regex"
466       },
467       "showConditions": {
468         "alwaysHide": true,
469         "hasOptions": true,
470         "hasDocument": true,
471         "hasNoLineItems": true,
472         "paymentSourceTypes": [
473           "custom",
474           "custom"
475         ],
476         "paymentSourceCustomSchemaIds": [
477           "paymentSourceCustomSchemaIds",
478           "paymentSourceCustomSchemaIds"
479         ],
480         "paymentDestinationTypes": [
481           "custom",
482           "custom"
483         ],
484         "paymentDestinationCustomSchemaIds": [
485           "paymentDestinationCustomSchemaIds",
486           "paymentDestinationCustomSchemaIds"
487         ]
488       }
489     }
490   ],
491   "notificationEmailTemplate": {
492     "backgroundStyle": "backgroundStyle",
493     "header": "header",
494     "body": "body",
495     "signature": "signature",
496     "footer": "footer",
497     "button": "button"
498   },
499   "customDomains": [
500     "customDomains",
501     "customDomains"
502   ],
503   "organizationEntityId": "organizationEntityId",
504   "rolePermissions": {
505     "rolePermissions": [
506       "invoice.all",
507       "invoice.all"
508     ]
509   }
510 }

Update current organization

Request

This endpoint expects an object.

namestringOptional

logostringOptional

websiteUrlstringOptional

supportEmailstringOptional

paymentMethodsobjectOptional

emailProviderobjectOptional

externalAccountingSystemProviderobjectOptional

colorSchemeobjectOptional

payeeOnboardingOptionsobjectOptional

payorOnboardingOptionsobjectOptional

metadataSchemalist of objectsOptional

notificationEmailTemplateobjectOptional

customDomainslist of stringsOptional

rolePermissionsmap from strings to lists of enumsOptional

Response

This endpoint returns an object.

idstring

sandboxboolean

namestring

logoUrlstringOptional