Organization

Get

GET
Get current organization information

Query parameters

paymentMethodsbooleanOptional
include supported payment methods in response
emailProviderbooleanOptional
include email 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

Response

This endpoint returns an object
id
string
sandbox
boolean
name
string
logoUrl
stringOptional
websiteUrl
stringOptional
supportEmail
stringOptional
paymentMethods
objectOptional
emailProvider
objectOptional
colorScheme
objectOptional
payeeOnboardingOptions
objectOptional
payorOnboardingOptions
objectOptional
metadataSchema
list of objectsOptional
GET
$curl -G https://api.mercoa.com/organization \
> -H "Authorization: Bearer <token>" \
> -d paymentMethods=true \
> -d emailProvider=true
Response
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 "active": true,
12 "available": true,
13 "name": "string",
14 "type": "custom",
15 "description": "string",
16 "markup": {
17 "type": "flat",
18 "amount": 1
19 }
20 }
21 ],
22 "backupDisbursements": [
23 {
24 "active": true,
25 "available": true,
26 "name": "string",
27 "type": "custom",
28 "description": "string",
29 "markup": {
30 "type": "flat",
31 "amount": 1
32 }
33 }
34 ],
35 "vendorDisbursements": [
36 {
37 "active": true,
38 "available": true,
39 "name": "string",
40 "type": "custom",
41 "description": "string",
42 "markup": {
43 "type": "flat",
44 "amount": 1
45 }
46 }
47 ]
48 },
49 "emailProvider": {
50 "sender": {
51 "provider": "none",
52 "fromEmail": "string",
53 "fromName": "string",
54 "hasApiKey": true
55 },
56 "inboxDomain": "string"
57 },
58 "colorScheme": {
59 "primaryColor": "string",
60 "secondaryColor": "string",
61 "logoBackgroundColor": "string"
62 },
63 "payeeOnboardingOptions": {
64 "enableBusiness": true,
65 "enableIndividual": true,
66 "paymentMethod": true,
67 "business": {
68 "termsOfService": {
69 "show": true,
70 "edit": true,
71 "required": true
72 },
73 "email": {
74 "show": true,
75 "edit": true,
76 "required": true
77 },
78 "name": {
79 "show": true,
80 "edit": true,
81 "required": true
82 },
83 "type": {
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 "address": {
99 "show": true,
100 "edit": true,
101 "required": true
102 },
103 "phone": {
104 "show": true,
105 "edit": true,
106 "required": true
107 },
108 "formationDate": {
109 "show": true,
110 "edit": true,
111 "required": true
112 },
113 "website": {
114 "show": true,
115 "edit": true,
116 "required": true
117 },
118 "description": {
119 "show": true,
120 "edit": true,
121 "required": true
122 },
123 "representatives": {
124 "show": true,
125 "edit": true,
126 "required": true
127 }
128 },
129 "individual": {
130 "termsOfService": {
131 "show": true,
132 "edit": true,
133 "required": true
134 },
135 "email": {
136 "show": true,
137 "edit": true,
138 "required": true
139 },
140 "name": {
141 "show": true,
142 "edit": true,
143 "required": true
144 },
145 "dateOfBirth": {
146 "show": true,
147 "edit": true,
148 "required": true
149 },
150 "ssn": {
151 "show": true,
152 "edit": true,
153 "required": true
154 },
155 "address": {
156 "show": true,
157 "edit": true,
158 "required": true
159 },
160 "phone": {
161 "show": true,
162 "edit": true,
163 "required": true
164 }
165 }
166 },
167 "payorOnboardingOptions": {
168 "enableBusiness": true,
169 "enableIndividual": true,
170 "paymentMethod": true,
171 "business": {
172 "termsOfService": {
173 "show": true,
174 "edit": true,
175 "required": true
176 },
177 "email": {
178 "show": true,
179 "edit": true,
180 "required": true
181 },
182 "name": {
183 "show": true,
184 "edit": true,
185 "required": true
186 },
187 "type": {
188 "show": true,
189 "edit": true,
190 "required": true
191 },
192 "doingBusinessAs": {
193 "show": true,
194 "edit": true,
195 "required": true
196 },
197 "ein": {
198 "show": true,
199 "edit": true,
200 "required": true
201 },
202 "address": {
203 "show": true,
204 "edit": true,
205 "required": true
206 },
207 "phone": {
208 "show": true,
209 "edit": true,
210 "required": true
211 },
212 "formationDate": {
213 "show": true,
214 "edit": true,
215 "required": true
216 },
217 "website": {
218 "show": true,
219 "edit": true,
220 "required": true
221 },
222 "description": {
223 "show": true,
224 "edit": true,
225 "required": true
226 },
227 "representatives": {
228 "show": true,
229 "edit": true,
230 "required": true
231 }
232 },
233 "individual": {
234 "termsOfService": {
235 "show": true,
236 "edit": true,
237 "required": true
238 },
239 "email": {
240 "show": true,
241 "edit": true,
242 "required": true
243 },
244 "name": {
245 "show": true,
246 "edit": true,
247 "required": true
248 },
249 "dateOfBirth": {
250 "show": true,
251 "edit": true,
252 "required": true
253 },
254 "ssn": {
255 "show": true,
256 "edit": true,
257 "required": true
258 },
259 "address": {
260 "show": true,
261 "edit": true,
262 "required": true
263 },
264 "phone": {
265 "show": true,
266 "edit": true,
267 "required": true
268 }
269 }
270 },
271 "metadataSchema": [
272 {
273 "key": "string",
274 "displayName": "string",
275 "type": "STRING",
276 "description": "string",
277 "lineItem": true,
278 "allowMultiple": true,
279 "showConditions": {
280 "hasOptions": true,
281 "hasDocument": true,
282 "hasNoLineItems": true,
283 "paymentSourceTypes": [
284 "custom"
285 ],
286 "paymentSourceCustomSchemaIds": [
287 "string"
288 ],
289 "paymentDestinationTypes": [
290 "custom"
291 ],
292 "paymentDestinationCustomSchemaIds": [
293 "string"
294 ]
295 }
296 }
297 ]
298}