Create Platform Merchant

Create a platform sub-merchant

SecurityLimepay-Token
Request
Request Body schema: application/json
slug
required
string

Helps form the unique URL that will be used for dashboards. Must be 4-255 characters, lowercase, alphanumeric without any special characters such as ! @ # & ( ) – [ ] : ; ‘, ? /.

contactEmail
required
string

Used for authenticating into the Limepay merchant dashboard

businessName
required
string

Business name (as linked to ABN/ACN)

taxCountry
required
string (Country)

ISO-3166 two letter country code for where the merchant is a tax resident.

Enum: "AU" "NZ" "ZA"
dashboardReferrer
string (DashboardReferrer)

Which dashboard to generate onboarding links for.

Enum: "Platform" "Merchant"
tradingCountry
string (Country)

ISO-3166 two letter country code for where the merchant is a tax resident.

Enum: "AU" "NZ" "ZA"
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/marketplaces/onboarding
Request samples
application/json
{
  • "slug": "mybusiness",
  • "contactEmail": "lucy.diamond@star.com",
  • "businessName": "string",
  • "taxCountry": "AU",
  • "dashboardReferrer": "Platform",
  • "tradingCountry": "AU"
}
Response samples
application/json
{
  • "merchantId": "mcht_ZmpO3_Umx0WmN5ff"
}
Copyright © April Solutions 2023. All right reserved.