API ReferenceOrganization

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

Response

This endpoint returns an object

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

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   },
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       "mcc": {
89         "show": true,
90         "edit": true,
91         "required": true
92       },
93       "address": {
94         "show": true,
95         "edit": true,
96         "required": true
97       },
98       "phone": {
99         "show": true,
100         "edit": true,
101         "required": true
102       },
103       "formationDate": {
104         "show": true,
105         "edit": true,
106         "required": true
107       },
108       "website": {
109         "show": true,
110         "edit": true,
111         "required": true
112       },
113       "description": {
114         "show": true,
115         "edit": true,
116         "required": true
117       },
118       "representatives": {
119         "show": true,
120         "edit": true,
121         "required": true
122       },
123       "logo": {
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       "mcc": {
203         "show": true,
204         "edit": true,
205         "required": true
206       },
207       "address": {
208         "show": true,
209         "edit": true,
210         "required": true
211       },
212       "phone": {
213         "show": true,
214         "edit": true,
215         "required": true
216       },
217       "formationDate": {
218         "show": true,
219         "edit": true,
220         "required": true
221       },
222       "website": {
223         "show": true,
224         "edit": true,
225         "required": true
226       },
227       "description": {
228         "show": true,
229         "edit": true,
230         "required": true
231       },
232       "representatives": {
233         "show": true,
234         "edit": true,
235         "required": true
236       },
237       "logo": {
238         "show": true,
239         "edit": true,
240         "required": true
241       }
242     },
243     "individual": {
244       "termsOfService": {
245         "show": true,
246         "edit": true,
247         "required": true
248       },
249       "email": {
250         "show": true,
251         "edit": true,
252         "required": true
253       },
254       "name": {
255         "show": true,
256         "edit": true,
257         "required": true
258       },
259       "dateOfBirth": {
260         "show": true,
261         "edit": true,
262         "required": true
263       },
264       "ssn": {
265         "show": true,
266         "edit": true,
267         "required": true
268       },
269       "address": {
270         "show": true,
271         "edit": true,
272         "required": true
273       },
274       "phone": {
275         "show": true,
276         "edit": true,
277         "required": true
278       }
279     }
280   },
281   "metadataSchema": [
282     {
283       "key": "string",
284       "displayName": "string",
285       "type": "STRING",
286       "description": "string",
287       "lineItem": true,
288       "allowMultiple": true,
289       "validationRules": {
290         "type": "regex",
291         "errorMessage": "string",
292         "regex": "string"
293       },
294       "showConditions": {
295         "hasOptions": true,
296         "hasDocument": true,
297         "hasNoLineItems": true,
298         "paymentSourceTypes": [
299           "custom"
300         ],
301         "paymentSourceCustomSchemaIds": [
302           "string"
303         ],
304         "paymentDestinationTypes": [
305           "custom"
306         ],
307         "paymentDestinationCustomSchemaIds": [
308           "string"
309         ]
310       }
311     }
312   ]
313 }

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	},
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	"mcc": {
89	"show": true,
90	"edit": true,
91	"required": true
92	},
93	"address": {
94	"show": true,
95	"edit": true,
96	"required": true
97	},
98	"phone": {
99	"show": true,
100	"edit": true,
101	"required": true
102	},
103	"formationDate": {
104	"show": true,
105	"edit": true,
106	"required": true
107	},
108	"website": {
109	"show": true,
110	"edit": true,
111	"required": true
112	},
113	"description": {
114	"show": true,
115	"edit": true,
116	"required": true
117	},
118	"representatives": {
119	"show": true,
120	"edit": true,
121	"required": true
122	},
123	"logo": {
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	"mcc": {
203	"show": true,
204	"edit": true,
205	"required": true
206	},
207	"address": {
208	"show": true,
209	"edit": true,
210	"required": true
211	},
212	"phone": {
213	"show": true,
214	"edit": true,
215	"required": true
216	},
217	"formationDate": {
218	"show": true,
219	"edit": true,
220	"required": true
221	},
222	"website": {
223	"show": true,
224	"edit": true,
225	"required": true
226	},
227	"description": {
228	"show": true,
229	"edit": true,
230	"required": true
231	},
232	"representatives": {
233	"show": true,
234	"edit": true,
235	"required": true
236	},
237	"logo": {
238	"show": true,
239	"edit": true,
240	"required": true
241	}
242	},
243	"individual": {
244	"termsOfService": {
245	"show": true,
246	"edit": true,
247	"required": true
248	},
249	"email": {
250	"show": true,
251	"edit": true,
252	"required": true
253	},
254	"name": {
255	"show": true,
256	"edit": true,
257	"required": true
258	},
259	"dateOfBirth": {
260	"show": true,
261	"edit": true,
262	"required": true
263	},
264	"ssn": {
265	"show": true,
266	"edit": true,
267	"required": true
268	},
269	"address": {
270	"show": true,
271	"edit": true,
272	"required": true
273	},
274	"phone": {
275	"show": true,
276	"edit": true,
277	"required": true
278	}
279	}
280	},
281	"metadataSchema": [
282	{
283	"key": "string",
284	"displayName": "string",
285	"type": "STRING",
286	"description": "string",
287	"lineItem": true,
288	"allowMultiple": true,
289	"validationRules": {
290	"type": "regex",
291	"errorMessage": "string",
292	"regex": "string"
293	},
294	"showConditions": {
295	"hasOptions": true,
296	"hasDocument": true,
297	"hasNoLineItems": true,
298	"paymentSourceTypes": [
299	"custom"
300	],
301	"paymentSourceCustomSchemaIds": [
302	"string"
303	],
304	"paymentDestinationTypes": [
305	"custom"
306	],
307	"paymentDestinationCustomSchemaIds": [
308	"string"
309	]
310	}
311	}
312	]
313	}