Skip to main content
POST
/
submerchants
curl --location 'https://api.hub2.io/submerchants' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: live' \
--header 'Content-Type: application/json' \
--data '{
  "name": "EM_TEST_01",
  "description": "Submerchant created for testing purposes",
  "address": "RIVIERA BEVERLY HILLS",
  "zipcode": "00225",
  "city": "ABIDJAN",
  "country": "CI",
  "currency": "XAF",
  "phoneNumber": "+2250707070707"
}'

{
       "id": "wwIxF40ciS6NVQddoa5BQ",
       "createdAt": "2025-11-27T18:37:55.033Z",
       "updatedAt": "2025-11-28T00:00:00.803Z",
       "name": "EM_TEST_01",
       "description": "Submerchant created for testing purposes",
       "country": "CI",
       "currency": "XOF",
       "members": [],
       "preferences": {
           "paymentWaveRestrictMsisdnEnabled": true
       },
       "address": "RIVIERA BEVERLY HILLS",
       "zipcode": "00225",
       "city": "ABIDJAN",
       "status": "suspended",
       "activity": "inactive_90_days",
       "isActive": true,
       "phoneNumber": null,
       "isAggregator": false,
       "policies": null,
       "legalInfo": null,
       "internalCode": "17B"
       "merchantGroup": "tkExvG2obnQtXsrNMUw5d" 
}
The Submerchant API allows you to create submerchant so that you can use their unique ID for transactions while ensuring compliance with regulatory requirements.

​
Request Parameters

​
name
string
required
Name of the submerchant (e.g., Submerchant Name)
​
description
string
A description of the submerchant (e.g., Submerchant description). This field can be used to give information regarding submerchant activity.
​
address
string
The street address of the submerchant (e.g., RIVIERA BEVERLY HILLSt).
​
zipcode
string
  The postal code or zip code of the submerchant (e.g., 00225).
​
city
string
  The city of the submerchant (e.g., ABIDJAN).
​
phoneNumber
string
  The phone number of the submerchant (e.g., +2250707070707).

​
Response

HTTP Status: 201 Created
​
id
string
The unique ID for the submerchant (e.g., wwIxF40ciS6NVQddoa5BQ).
​
name
string
  The name of the submerchant (e.g., EM_TEST_01).
​
description
string
  A description of the submerchant (e.g., Submerchant created for testing purposes).
​
address
string
  The street address of the submerchant.
​
zipcode
string
  The postal code or zip code of the submerchant.
​
city
string
  The city of the submerchant (e.g., ABIDJAN).
​
country
string
  The two-letter ISO country code associated with the submerchant (e.g., CI). This value is inherited from the merchant.
​
currency
string
  The currency code used by the submerchant (e.g., XOF). This value is inherited from the merchant.
​
phoneNumber
string
  The phone number of the submerchant (e.g., +2250707070707).
​
isActive
boolean
  A boolean flag indicating if the submerchant account is currently active (e.g., true).
​
status
string
  The current operational status of the submerchant account (e.g., live).
Possible values: live, sandbox, testing, suspended, archived
​
activity
string
  The defined activity level or performance tier of the submerchant (e.g., top_performer). Possible values: new, top_performer , low_performer, watch_list
​
preferences
object
  An object containing specific configuration settings and preferences for the submerchant. This value is inherited from the merchant.
​
members
array
  A list of users associated with the submerchant account (e.g., []).
​
createdAt
string
  The date and time the submerchant was created, in ISO 8601 format (e.g., 2025-11-28T18:21:44.687Z).
​
updatedAt
string
  The date and time the submerchant was last updated, in ISO 8601 format (e.g., 2025-11-28T18:21:44.750Z).
​
legalInfo
null
  Legal information associated with the submerchant (e.g., null).
​
internalCode
string
  An internal code or reference number for the submerchant (e.g., 17C).
​
policies
null
  Applicable policies or terms for the submerchant (e.g., null).
​
isAggregator
boolean
  A boolean flag indicating if the submerchant is configured as an aggregator (e.g., false).
​
merchantGroup
string
  The ID of the merchant group to which the submerchant belongs (e.g., tkExvG2obnQtXsrNMUw5d).
curl --location 'https://api.hub2.io/submerchants' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: live' \
--header 'Content-Type: application/json' \
--data '{
  "name": "EM_TEST_01",
  "description": "Submerchant created for testing purposes",
  "address": "RIVIERA BEVERLY HILLS",
  "zipcode": "00225",
  "city": "ABIDJAN",
  "country": "CI",
  "currency": "XAF",
  "phoneNumber": "+2250707070707"
}'

{
       "id": "wwIxF40ciS6NVQddoa5BQ",
       "createdAt": "2025-11-27T18:37:55.033Z",
       "updatedAt": "2025-11-28T00:00:00.803Z",
       "name": "EM_TEST_01",
       "description": "Submerchant created for testing purposes",
       "country": "CI",
       "currency": "XOF",
       "members": [],
       "preferences": {
           "paymentWaveRestrictMsisdnEnabled": true
       },
       "address": "RIVIERA BEVERLY HILLS",
       "zipcode": "00225",
       "city": "ABIDJAN",
       "status": "suspended",
       "activity": "inactive_90_days",
       "isActive": true,
       "phoneNumber": null,
       "isAggregator": false,
       "policies": null,
       "legalInfo": null,
       "internalCode": "17B"
       "merchantGroup": "tkExvG2obnQtXsrNMUw5d" 
}