Get

GET

https://api.mercoa.com/organization

GET

/organization

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.organization.get()

Try it

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

Get current organization information

Query parameters

paymentMethodsbooleanOptional

include supported payment methods in response

emailProviderbooleanOptional

include email provider info in response

externalAccountingSystemProviderbooleanOptional

include external accounting system provider info in response

colorSchemebooleanOptional

include color scheme info in response

payeeOnboardingOptionsbooleanOptional

include payee onboarding options in response

payorOnboardingOptionsbooleanOptional

include payor onboarding options in response

metadataSchemabooleanOptional

include metadata schema in response

notificationEmailTemplatebooleanOptional

include notification-email-template in response

rolePermissionsbooleanOptional

include role permission config in response

customDomainsbooleanOptional

include custom domains in response

Response

This endpoint returns an object.

idstring

sandboxboolean

namestring

logoUrlstring or null

faviconUrlstring or null

websiteUrlstring or null

supportEmailstring or null

paymentMethodsobject or null

emailProviderobject or null

externalAccountingSystemProviderobject or null

colorSchemeobject or null

payeeOnboardingOptionsobject or null

payorOnboardingOptionsobject or null

metadataSchemalist of objects or null

notificationEmailTemplateobject or null

customDomainslist of strings or null

organizationEntityIdstring or null

rolePermissionsmap from strings to lists of enums or null

Get

Headers

Query parameters

Response

Errors