Verify merchant email
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/', 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://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyMerchant
Verify merchant email
Verify the email address of a merchant based on their verification token.
This endpoint allows merchants to verify their email addresses after account creation.
It is triggered when the merchant clicks on the verification link sent to their email.
Args:
request (HttpRequest): The incoming HTTP request. The request must include a valid
`token` as a query parameter.
merchant_id (str): This parameter represents the merchant's unique identifier,
also referred to as the "short_code" internally. Though renamed to `merchant_id`,
the underlying functionality remains unchanged. It helps map merchants in the system.
*args: Additional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response (JSON): Returns a JSON response indicating success or failure of the email
verification process.
Success Response (HTTP 200):
{
"message": (
"Email verified successfully. Please check your email for onboarding instructions. "
"If you do not receive an email, please check your spam folder. If you still do not receive an email, "
"please contact support with error code: ONBOARDING_MSG_NOT_RECEIVED."
)
}
Failure Response (HTTP 400):
{
"error": "Invalid verification token"
}
Key Details for Non-Technical Stakeholders:
- This API is part of the merchant onboarding process, ensuring that the merchant's
email is verified before they can fully access the platform.
- The `merchant_id` in the URL is a placeholder that simplifies the naming convention
for external users but internally still maps to the original "short_code".
- The email verification token must be provided by the merchant via the verification link.
- If the email is successfully verified, the merchant receives onboarding instructions via email.
Key Details for Developers:
- The `merchant_id` parameter is simply an alias for `short_code`, preserving
backward compatibility with existing logic.
- The token is checked for validity, and if it has expired or is incorrect,
the request is rejected with a 400 response.
- Upon successful verification, the merchant's status is updated to verified, and
the onboarding email is sent. Errors during email dispatch are logged but do not block verification.
- Ensure the token expiration logic works properly to prevent expired tokens from being reused.
GET
/
api
/
v1
/
merchants
/
{merchant_id}
/
verify
/
Verify merchant email
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/', 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://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/merchants/{merchant_id}/verify/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyRetrieve a merchant instance by its `merchant_id` (merchant id, refers to a unique merchant code assigned to the merchant)Update a merchant information as a customer support agent
⌘I