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