Get

GET

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

customDomainsbooleanOptional

include custom domains in response

Response

This endpoint returns an object.

idstring

sandboxboolean

namestring

logoUrlstringOptional

websiteUrlstringOptional

supportEmailstringOptional

paymentMethodsobjectOptional

emailProviderobjectOptional

externalAccountingSystemProviderobjectOptional

colorSchemeobjectOptional

payeeOnboardingOptionsobjectOptional

payorOnboardingOptionsobjectOptional

metadataSchemalist of objectsOptional

notificationEmailTemplateobjectOptional

customDomainslist of stringsOptional

organizationEntityIdstringOptional

GET

1 curl -G https://api.mercoa.com/organization \
2      -H "Authorization: Bearer <token>" \
3      -d paymentMethods=true \
4      -d emailProvider=true

200Retrieved

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

Update

Up Next

Built with

1	curl -G https://api.mercoa.com/organization \
2	-H "Authorization: Bearer <token>" \
3	-d paymentMethods=true \
4	-d emailProvider=true

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