curl --request GET \
--url https://api.example.com/submerchants \
--header 'ApiKey: <apikey>' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>'import requests
url = "https://api.example.com/submerchants"
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {ApiKey: '<apikey>', MerchantId: '<merchantid>', Environment: '<environment>'}
};
fetch('https://api.example.com/submerchants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/submerchants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/submerchants"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/submerchants")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/submerchants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
response = http.request(request)
puts response.read_body[
{
"id": "mch_1a2b3c",
"createdAt": "2026-08-13T09:00:00.000Z",
"name": "Submerchant Name",
"defaultCurrency": "XOF",
"status": "closed",
"isActive": true,
"isAggregator": true,
"members": [
"<string>"
],
"activity": "compliance",
"description": "<string>",
"address": "<string>",
"zipcode": "<string>",
"city": "<string>",
"phoneNumber": "<string>",
"country": "CI",
"preferences": {},
"internalCode": "<string>",
"merchantGroupId": "<string>",
"details": {},
"enabledProducts": [
"<string>"
],
"legalInfo": {
"legalName": "<string>",
"headOfficeAddress": "<string>",
"businessActivity": "<string>",
"managerName": "<string>",
"websiteURL": "<string>",
"isBetting": true,
"isCrypto": true,
"isNGO": true
}
}
]{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"httpStatus": 404,
"message": "X not found",
"error": "Not found"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted"
],
"message": "An error occurred on our system. Please try again later."
}List submerchants
curl --request GET \
--url https://api.example.com/submerchants \
--header 'ApiKey: <apikey>' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>'import requests
url = "https://api.example.com/submerchants"
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {ApiKey: '<apikey>', MerchantId: '<merchantid>', Environment: '<environment>'}
};
fetch('https://api.example.com/submerchants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/submerchants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/submerchants"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/submerchants")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/submerchants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
response = http.request(request)
puts response.read_body[
{
"id": "mch_1a2b3c",
"createdAt": "2026-08-13T09:00:00.000Z",
"name": "Submerchant Name",
"defaultCurrency": "XOF",
"status": "closed",
"isActive": true,
"isAggregator": true,
"members": [
"<string>"
],
"activity": "compliance",
"description": "<string>",
"address": "<string>",
"zipcode": "<string>",
"city": "<string>",
"phoneNumber": "<string>",
"country": "CI",
"preferences": {},
"internalCode": "<string>",
"merchantGroupId": "<string>",
"details": {},
"enabledProducts": [
"<string>"
],
"legalInfo": {
"legalName": "<string>",
"headOfficeAddress": "<string>",
"businessActivity": "<string>",
"managerName": "<string>",
"websiteURL": "<string>",
"isBetting": true,
"isCrypto": true,
"isNGO": true
}
}
]{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"httpStatus": 404,
"message": "X not found",
"error": "Not found"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted"
],
"message": "An error occurred on our system. Please try again later."
}Headers
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.
Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
live, sandbox Response
List of submerchants
Identifier of the merchant
"mch_1a2b3c"
Creation date of the merchant, ISO 8601
"2026-08-13T09:00:00.000Z"
Name of the merchant
"Submerchant Name"
Default currency of the merchant, ISO 4217
"XOF"
Status of the merchant
closed, live, sandbox, suspended, testing, initialized Whether the merchant is active
Whether the merchant is an aggregator
Identifiers of the users that are members of the merchant
Activity of the merchant
compliance, inactive_30_days, inactive_90_days, low_performer, newcomer, top_performer, watch_list Description of the merchant
Address of the merchant
Zipcode of the merchant
City of the merchant
Phone number of the merchant
Country of the merchant, ISO 3166-1 alpha-2
"CI"
Preferences of the merchant
Internal code of the merchant
Identifier of the group the merchant belongs to
Additional details of the merchant
Products enabled for the merchant
Legal info of the submerchant
Show child attributes
Show child attributes
