Organization

Update

POST
Update current organization

Request

This endpoint expects an object.
name
stringOptional
logo
stringOptional
websiteUrl
stringOptional
supportEmail
stringOptional
paymentMethods
objectOptional
emailProvider
objectOptional
externalAccountingSystemProvider
unionOptional
colorScheme
objectOptional
payeeOnboardingOptions
objectOptional
payorOnboardingOptions
objectOptional
metadataSchema
list of objectsOptional

Response

This endpoint returns an object
id
string
sandbox
boolean
name
string
logoUrl
stringOptional
websiteUrl
stringOptional
supportEmail
stringOptional
paymentMethods
objectOptional
emailProvider
objectOptional
externalAccountingSystemProvider
unionOptional
colorScheme
objectOptional
payeeOnboardingOptions
objectOptional
payorOnboardingOptions
objectOptional
metadataSchema
list of objectsOptional
POST
1curl -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 "termsOfService": {
59 "show": true,
60 "edit": true,
61 "required": true
62 },
63 "email": {
64 "show": true,
65 "edit": true,
66 "required": true
67 },
68 "name": {
69 "show": true,
70 "edit": true,
71 "required": true
72 },
73 "type": {
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 "address": {
89 "show": true,
90 "edit": true,
91 "required": true
92 },
93 "phone": {
94 "show": true,
95 "edit": true,
96 "required": true
97 },
98 "formationDate": {
99 "show": true,
100 "edit": true,
101 "required": true
102 },
103 "website": {
104 "show": true,
105 "edit": true,
106 "required": true
107 },
108 "description": {
109 "show": true,
110 "edit": true,
111 "required": true
112 },
113 "representatives": {
114 "show": true,
115 "edit": true,
116 "required": true
117 }
118 },
119 "individual": {
120 "termsOfService": {
121 "show": true,
122 "edit": true,
123 "required": true
124 },
125 "email": {
126 "show": true,
127 "edit": true,
128 "required": true
129 },
130 "name": {
131 "show": true,
132 "edit": true,
133 "required": true
134 },
135 "dateOfBirth": {
136 "show": true,
137 "edit": true,
138 "required": true
139 },
140 "ssn": {
141 "show": true,
142 "edit": true,
143 "required": true
144 },
145 "address": {
146 "show": true,
147 "edit": true,
148 "required": true
149 },
150 "phone": {
151 "show": true,
152 "edit": true,
153 "required": true
154 }
155 }
156 },
157 "payorOnboardingOptions": {
158 "enableBusiness": true,
159 "enableIndividual": true,
160 "paymentMethod": true,
161 "business": {
162 "termsOfService": {
163 "show": true,
164 "edit": true,
165 "required": true
166 },
167 "email": {
168 "show": true,
169 "edit": true,
170 "required": true
171 },
172 "name": {
173 "show": true,
174 "edit": true,
175 "required": true
176 },
177 "type": {
178 "show": true,
179 "edit": true,
180 "required": true
181 },
182 "doingBusinessAs": {
183 "show": true,
184 "edit": true,
185 "required": true
186 },
187 "ein": {
188 "show": true,
189 "edit": true,
190 "required": true
191 },
192 "address": {
193 "show": true,
194 "edit": true,
195 "required": true
196 },
197 "phone": {
198 "show": true,
199 "edit": true,
200 "required": true
201 },
202 "formationDate": {
203 "show": true,
204 "edit": true,
205 "required": true
206 },
207 "website": {
208 "show": true,
209 "edit": true,
210 "required": true
211 },
212 "description": {
213 "show": true,
214 "edit": true,
215 "required": true
216 },
217 "representatives": {
218 "show": true,
219 "edit": true,
220 "required": true
221 }
222 },
223 "individual": {
224 "termsOfService": {
225 "show": true,
226 "edit": true,
227 "required": true
228 },
229 "email": {
230 "show": true,
231 "edit": true,
232 "required": true
233 },
234 "name": {
235 "show": true,
236 "edit": true,
237 "required": true
238 },
239 "dateOfBirth": {
240 "show": true,
241 "edit": true,
242 "required": true
243 },
244 "ssn": {
245 "show": true,
246 "edit": true,
247 "required": true
248 },
249 "address": {
250 "show": true,
251 "edit": true,
252 "required": true
253 },
254 "phone": {
255 "show": true,
256 "edit": true,
257 "required": true
258 }
259 }
260 },
261 "metadataSchema": [
262 {
263 "key": "string",
264 "displayName": "string",
265 "type": "STRING",
266 "description": "string",
267 "lineItem": true,
268 "allowMultiple": true,
269 "validationRules": {
270 "type": "regex",
271 "errorMessage": "string",
272 "regex": "string"
273 },
274 "showConditions": {
275 "hasOptions": true,
276 "hasDocument": true,
277 "hasNoLineItems": true,
278 "paymentSourceTypes": [
279 "custom"
280 ],
281 "paymentSourceCustomSchemaIds": [
282 "string"
283 ],
284 "paymentDestinationTypes": [
285 "custom"
286 ],
287 "paymentDestinationCustomSchemaIds": [
288 "string"
289 ]
290 }
291 }
292 ]
293}