HUhub2
Submerchants

Create a submerchant

Changed on
post/submerchants

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Request body

namestring required

Name of the submerchant

descriptionstring required

Description of the submerchant

addressstring

Address of the submerchant

zipcodestring

Zipcode of the submerchant

citystring

City of the submerchant

phoneNumberstring

Phone number of the submerchant

Example request

{
  "name": "Submerchant Name",
  "description": "Submerchant description",
  "address": "123 Main St",
  "zipcode": "12345",
  "city": "New York",
  "phoneNumber": "+1234567890"
}

Response

Submerchant created successfully

idstring required

Identifier of the submerchant

namestring required

Name of the submerchant

descriptionstring

Description of the submerchant

status'closed' | 'live' | 'sandbox' | 'suspended' | 'testing' | 'initialized' required

Status of the submerchant

isActiveboolean required

Whether the submerchant is active

isAggregatorboolean required

Whether the submerchant is an aggregator

defaultCurrencystring required

Default currency of the submerchant, ISO 4217

countrystring

Country of the submerchant, ISO 3166-1 alpha-2

addressstring

Address of the submerchant

zipcodestring

Zipcode of the submerchant

citystring

City of the submerchant

phoneNumberstring

Phone number of the submerchant

createdAtstring required

Creation date of the submerchant, ISO 8601

Example response

{
  "id": "mch_1a2b3c",
  "name": "Submerchant Name",
  "defaultCurrency": "XOF",
  "country": "CI",
  "createdAt": "2026-08-13T09:00:00.000Z"
}

Changes