Skip to main content
POST
/
api
/
v1
/
merchants
Register a new merchant on Unyte
curl --request POST \
  --url https://dev.superpool.unyte.africa/api/v1/merchants/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "company_name": "<string>",
  "business_email": "jsmith@example.com",
  "support_email": "jsmith@example.com"
}
'
{
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_trashed": true,
  "trashed_at": "2023-11-07T05:31:56Z",
  "restored_at": "2023-11-07T05:31:56Z",
  "short_code": "<string>",
  "business_email": "jsmith@example.com",
  "support_email": "jsmith@example.com",
  "is_active": true,
  "tax_identification_number": "<string>",
  "registration_number": "<string>",
  "address": "<string>",
  "kyc_verified": true,
  "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-API-Key
string
header
required

Body

Handles the creation of new Merchants

​
company_name
string
required
​
business_email
string<email> | null
required

Company registration email address

Maximum string length: 254
​
support_email
string<email> | null

The contact email address of the business, for support if any

Maximum string length: 254

Response

200 - application/json

Serializer for Merchant model

​
id
integer
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
name
string
required

The name of the business

Maximum string length: 255
​
tenant_id
string<uuid> | null
required
read-only

Unique identifier for the merchant in the system

​
is_trashed
boolean
​
trashed_at
string<date-time> | null
​
restored_at
string<date-time> | null
​
short_code
string | null

Unique short code indentifier used internally to identify a merchant or distributore.g. UBA-X224, GTB-3X2, KON-001, SLOT-001, WEMA-2286, etc.

Maximum string length: 10
​
business_email
string<email> | null

Company registration email address

Maximum string length: 254
​
support_email
string<email> | null

The contact email address of the business, for support if any

Maximum string length: 254
​
is_active
boolean

Designates if the merchant is active

​
tax_identification_number
string | null

Unique tax identification number issued by federal or inland revenue service

Maximum string length: 40
​
registration_number
string | null

Government-issued registration number with the CAC

Maximum string length: 40
​
address
string | null

The physical address of the business

​
kyc_verified
boolean

Designates if the business has been verified by the platform

​
user
string<uuid> | null

ID of the user