Organization

Get

GET
https://api.mercoa.com/organization

Get current organization information

Query parameters

paymentMethods
optional boolean

include supported payment methods in response

emailProvider
optional boolean

include email provider info in response

colorScheme
optional boolean

include color scheme info in response

payeeOnboardingOptions
optional boolean

include payee onboarding options in response

payorOnboardingOptions
optional boolean

include payor onboarding options in response

metadataSchema
optional boolean

include metadata schema in response

Response

This endpoint return an object.
id
string
sandbox
boolean
name
string
logoUrl
optional string
websiteUrl
optional string
supportEmail
optional string
paymentMethods
optional object
emailProvider
optional object
colorScheme
optional object
payeeOnboardingOptions
optional object
payorOnboardingOptions
optional object
metadataSchema
optional list of objects
GET
/organization
curl -G https://api.mercoa.com/organization \
-H "Authorization: Bearer <token>" \
-d paymentMethods=true \
-d emailProvider=true
Response
{
"id": "string",
"sandbox": true,
"name": "string",
"logoUrl": "string",
"websiteUrl": "string",
"supportEmail": "string",
"paymentMethods": {
"payerPayments": [
{
"active": true,
"available": true,
"name": "string",
"type": "custom",
"description": "string",
"markup": {
"type": "flat",
"amount": 1
}
}
],
"backupDisbursements": [
{
"active": true,
"available": true,
"name": "string",
"type": "custom",
"description": "string",
"markup": {
"type": "flat",
"amount": 1
}
}
],
"vendorDisbursements": [
{
"active": true,
"available": true,
"name": "string",
"type": "custom",
"description": "string",
"markup": {
"type": "flat",
"amount": 1
}
}
]
},
"emailProvider": {
"sender": {
"provider": "none",
"fromEmail": "string",
"fromName": "string",
"hasApiKey": true
},
"inboxDomain": "string"
},
"colorScheme": {
"primaryColor": "string",
"secondaryColor": "string",
"logoBackgroundColor": "string"
},
"payeeOnboardingOptions": {
"enableBusiness": true,
"enableIndividual": true,
"paymentMethod": true,
"business": {
"termsOfService": {
"show": true,
"edit": true,
"required": true
},
"email": {
"show": true,
"edit": true,
"required": true
},
"name": {
"show": true,
"edit": true,
"required": true
},
"type": {
"show": true,
"edit": true,
"required": true
},
"doingBusinessAs": {
"show": true,
"edit": true,
"required": true
},
"ein": {
"show": true,
"edit": true,
"required": true
},
"address": {
"show": true,
"edit": true,
"required": true
},
"phone": {
"show": true,
"edit": true,
"required": true
},
"formationDate": {
"show": true,
"edit": true,
"required": true
},
"website": {
"show": true,
"edit": true,
"required": true
},
"description": {
"show": true,
"edit": true,
"required": true
},
"representatives": {
"show": true,
"edit": true,
"required": true
}
},
"individual": {
"termsOfService": {
"show": true,
"edit": true,
"required": true
},
"email": {
"show": true,
"edit": true,
"required": true
},
"name": {
"show": true,
"edit": true,
"required": true
},
"dateOfBirth": {
"show": true,
"edit": true,
"required": true
},
"ssn": {
"show": true,
"edit": true,
"required": true
},
"address": {
"show": true,
"edit": true,
"required": true
},
"phone": {
"show": true,
"edit": true,
"required": true
}
}
},
"payorOnboardingOptions": {
"enableBusiness": true,
"enableIndividual": true,
"paymentMethod": true,
"business": {
"termsOfService": {
"show": true,
"edit": true,
"required": true
},
"email": {
"show": true,
"edit": true,
"required": true
},
"name": {
"show": true,
"edit": true,
"required": true
},
"type": {
"show": true,
"edit": true,
"required": true
},
"doingBusinessAs": {
"show": true,
"edit": true,
"required": true
},
"ein": {
"show": true,
"edit": true,
"required": true
},
"address": {
"show": true,
"edit": true,
"required": true
},
"phone": {
"show": true,
"edit": true,
"required": true
},
"formationDate": {
"show": true,
"edit": true,
"required": true
},
"website": {
"show": true,
"edit": true,
"required": true
},
"description": {
"show": true,
"edit": true,
"required": true
},
"representatives": {
"show": true,
"edit": true,
"required": true
}
},
"individual": {
"termsOfService": {
"show": true,
"edit": true,
"required": true
},
"email": {
"show": true,
"edit": true,
"required": true
},
"name": {
"show": true,
"edit": true,
"required": true
},
"dateOfBirth": {
"show": true,
"edit": true,
"required": true
},
"ssn": {
"show": true,
"edit": true,
"required": true
},
"address": {
"show": true,
"edit": true,
"required": true
},
"phone": {
"show": true,
"edit": true,
"required": true
}
}
},
"metadataSchema": [
{
"key": "string",
"displayName": "string",
"type": "STRING",
"description": "string",
"lineItem": true,
"allowMultiple": true,
"showConditions": {
"hasOptions": true,
"hasDocument": true,
"hasNoLineItems": true,
"paymentSourceTypes": [
"custom"
],
"paymentSourceCustomSchemaIds": [
"string"
],
"paymentDestinationTypes": [
"custom"
],
"paymentDestinationCustomSchemaIds": [
"string"
]
}
}
]
}