API Reference Organization

Update

POST

Update current organization

Request

This endpoint expects an object.

namestringOptional

logostringOptional

websiteUrlstringOptional

supportEmailstringOptional

paymentMethodsobjectOptional

emailProviderobjectOptional

externalAccountingSystemProviderobjectOptional

colorSchemeobjectOptional

payeeOnboardingOptionsobjectOptional

payorOnboardingOptionsobjectOptional

metadataSchemalist of objectsOptional

Response

This endpoint returns an object

idstring

sandboxboolean

namestring

logoUrlstringOptional

websiteUrlstringOptional

supportEmailstringOptional

paymentMethodsobjectOptional

emailProviderobjectOptional

externalAccountingSystemProviderobjectOptional

colorSchemeobjectOptional

payeeOnboardingOptionsobjectOptional

payorOnboardingOptionsobjectOptional

metadataSchemalist of objectsOptional

POST

1 curl -X POST https://api.mercoa.com/organization \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

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