Update

POST

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

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

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": "id",
3   "sandbox": true,
4   "name": "name",
5   "logoUrl": "logoUrl",
6   "websiteUrl": "websiteUrl",
7   "supportEmail": "supportEmail",
8   "paymentMethods": {
9     "payerPayments": [
10       {
11         "type": "custom",
12         "name": "name",
13         "active": true,
14         "available": true
15       },
16       {
17         "type": "custom",
18         "name": "name",
19         "active": true,
20         "available": true
21       }
22     ],
23     "backupDisbursements": [
24       {
25         "type": "custom",
26         "name": "name",
27         "active": true,
28         "available": true
29       },
30       {
31         "type": "custom",
32         "name": "name",
33         "active": true,
34         "available": true
35       }
36     ],
37     "vendorDisbursements": [
38       {
39         "type": "custom",
40         "name": "name",
41         "active": true,
42         "available": true
43       },
44       {
45         "type": "custom",
46         "name": "name",
47         "active": true,
48         "available": true
49       }
50     ]
51   },
52   "emailProvider": {
53     "sender": {
54       "provider": "none",
55       "fromEmail": "fromEmail",
56       "fromName": "fromName",
57       "hasApiKey": true
58     },
59     "inboxDomain": "inboxDomain",
60     "alternativeInboxDomains": [
61       "alternativeInboxDomains",
62       "alternativeInboxDomains"
63     ]
64   },
65   "externalAccountingSystemProvider": {
66     "type": "none",
67     "hasApiKey": true
68   },
69   "colorScheme": {
70     "primaryColor": "primaryColor",
71     "secondaryColor": "secondaryColor",
72     "logoBackgroundColor": "logoBackgroundColor",
73     "roundedCorners": 1,
74     "fontFamily": "fontFamily",
75     "fontSize": "fontSize"
76   },
77   "payeeOnboardingOptions": {
78     "enableBusiness": true,
79     "enableIndividual": true,
80     "paymentMethod": true,
81     "business": {
82       "averageMonthlyTransactionVolume": {
83         "show": true,
84         "edit": true,
85         "required": true
86       },
87       "averageTransactionSize": {
88         "show": true,
89         "edit": true,
90         "required": true
91       },
92       "description": {
93         "show": true,
94         "edit": true,
95         "required": true
96       },
97       "doingBusinessAs": {
98         "show": true,
99         "edit": true,
100         "required": true
101       },
102       "ein": {
103         "show": true,
104         "edit": true,
105         "required": true
106       },
107       "formationDate": {
108         "show": true,
109         "edit": true,
110         "required": true
111       },
112       "logo": {
113         "show": true,
114         "edit": true,
115         "required": true
116       },
117       "maxTransactionSize": {
118         "show": true,
119         "edit": true,
120         "required": true
121       },
122       "mcc": {
123         "show": true,
124         "edit": true,
125         "required": true
126       },
127       "representatives": {
128         "show": true,
129         "edit": true,
130         "required": true
131       },
132       "type": {
133         "show": true,
134         "edit": true,
135         "required": true
136       },
137       "website": {
138         "show": true,
139         "edit": true,
140         "required": true
141       }
142     },
143     "individual": {
144       "dateOfBirth": {
145         "show": true,
146         "edit": true,
147         "required": true
148       },
149       "ssn": {
150         "show": true,
151         "edit": true,
152         "required": true
153       }
154     }
155   },
156   "payorOnboardingOptions": {
157     "enableBusiness": true,
158     "enableIndividual": true,
159     "paymentMethod": true,
160     "business": {
161       "averageMonthlyTransactionVolume": {
162         "show": true,
163         "edit": true,
164         "required": true
165       },
166       "averageTransactionSize": {
167         "show": true,
168         "edit": true,
169         "required": true
170       },
171       "description": {
172         "show": true,
173         "edit": true,
174         "required": true
175       },
176       "doingBusinessAs": {
177         "show": true,
178         "edit": true,
179         "required": true
180       },
181       "ein": {
182         "show": true,
183         "edit": true,
184         "required": true
185       },
186       "formationDate": {
187         "show": true,
188         "edit": true,
189         "required": true
190       },
191       "logo": {
192         "show": true,
193         "edit": true,
194         "required": true
195       },
196       "maxTransactionSize": {
197         "show": true,
198         "edit": true,
199         "required": true
200       },
201       "mcc": {
202         "show": true,
203         "edit": true,
204         "required": true
205       },
206       "representatives": {
207         "show": true,
208         "edit": true,
209         "required": true
210       },
211       "type": {
212         "show": true,
213         "edit": true,
214         "required": true
215       },
216       "website": {
217         "show": true,
218         "edit": true,
219         "required": true
220       }
221     },
222     "individual": {
223       "dateOfBirth": {
224         "show": true,
225         "edit": true,
226         "required": true
227       },
228       "ssn": {
229         "show": true,
230         "edit": true,
231         "required": true
232       }
233     }
234   },
235   "metadataSchema": [
236     {
237       "key": "key",
238       "displayName": "displayName",
239       "type": "STRING",
240       "description": "description",
241       "lineItem": true,
242       "allowMultiple": true,
243       "validationRules": {
244         "type": "regex",
245         "errorMessage": "errorMessage",
246         "regex": "regex"
247       },
248       "showConditions": {
249         "hasOptions": true,
250         "hasDocument": true,
251         "hasNoLineItems": true,
252         "paymentSourceTypes": [
253           "custom",
254           "custom"
255         ],
256         "paymentSourceCustomSchemaIds": [
257           "paymentSourceCustomSchemaIds",
258           "paymentSourceCustomSchemaIds"
259         ],
260         "paymentDestinationTypes": [
261           "custom",
262           "custom"
263         ],
264         "paymentDestinationCustomSchemaIds": [
265           "paymentDestinationCustomSchemaIds",
266           "paymentDestinationCustomSchemaIds"
267         ]
268       }
269     },
270     {
271       "key": "key",
272       "displayName": "displayName",
273       "type": "STRING",
274       "description": "description",
275       "lineItem": true,
276       "allowMultiple": true,
277       "validationRules": {
278         "type": "regex",
279         "errorMessage": "errorMessage",
280         "regex": "regex"
281       },
282       "showConditions": {
283         "hasOptions": true,
284         "hasDocument": true,
285         "hasNoLineItems": true,
286         "paymentSourceTypes": [
287           "custom",
288           "custom"
289         ],
290         "paymentSourceCustomSchemaIds": [
291           "paymentSourceCustomSchemaIds",
292           "paymentSourceCustomSchemaIds"
293         ],
294         "paymentDestinationTypes": [
295           "custom",
296           "custom"
297         ],
298         "paymentDestinationCustomSchemaIds": [
299           "paymentDestinationCustomSchemaIds",
300           "paymentDestinationCustomSchemaIds"
301         ]
302       }
303     }
304   ],
305   "notificationEmailTemplate": {
306     "backgroundStyle": "backgroundStyle",
307     "header": "header",
308     "body": "body",
309     "signature": "signature",
310     "footer": "footer",
311     "button": "button"
312   },
313   "customDomains": [
314     "customDomains",
315     "customDomains"
316   ],
317   "organizationEntityId": "organizationEntityId"
318 }