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

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