Create organisation

post

https://api.ekko.earth/v3/organisations

Create an organisation under a parent organisation.

Body Params

parentOrganisationId

uuid

required

Parent organisation ID.

tradingName

string

required

legalName

string

required

address

object

required

currencyCode

string

required

length between 3 and 3

ISO 4217 currency code

website

uri | null

billing

object | null

Billing configuration for this organisation.

mcc

string | null

Merchant Category Code (4 digits)

If your organisation has a consistent MCC, set it here. Then you can omit merchant details when creating an impact quote or SDK session.

relativeProfitShare

number | null

0 to 1

Defaults to 0

Relative profit share expressed as a decimal (for example, 0.6 = 60%). This is the organisation's percentage of the service fee passed down from its parent.

organisationReference

string | null

Optional metadata field for your own internal references, such as a merchant ID, account ID, or CRM identifier.

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

201Organisation created

400Bad request

401Unauthorised

404Not found

500Server error