Brand onboarding

The Brand Onboarding endpoint is your starting point for working with the ekko API. It’s where you set up a new brand under your organisation, making sure all the legal, billing and configuration details are in place before you start calculating impact or processing contributions.

ℹ️

See the API reference for payload examples.

What it does

• Registers a new brand within your organisation
• Captures legal, billing and configuration details for that brand
• Inherits default project and product settings from the organisation
• Provides the brand’s unique identifiers (brandId, productId) needed for other API calls

Key fields explained

• tradingName → the name your customers see (e.g., merchant or product brand).
• tradingAddress → physical trading address of the brand.
• currency → the billing currency. Please note that billing can still happen in the transaction currency (converted at daily rates) on request.
• brandBilling → defines if invoices go to the brand directly (TRUE) or via the parent organisation (FALSE).
• brandOwner → allows you to map nested relationships where your clients manage their own brands. If left blank, we’ll assume your organisation owns the brand relationship.

ℹ️

Multi-currency brands

Multiple transaction currencies can be supported under a single brandId. The currency specified during the onboarding is treated as the billing currency.

If preferred, billing can happen in the transaction currency.

Best practices

• Keep brand information consistent with official records to ensure compliance.
• Set brandBilling carefully depending on whether the brand or parent organisation should handle invoices.
• Use a standardised brandReference if managing multiple brands under one organisation.
• Capture both tradingAddress and legalAddress for clarity and audit requirements.