Skip to main content
POST
/
v1
/
api
/
agent
/
create
Create Agent
curl --request POST \
  --url https://secureapi.tender.cash/v1/api/agent/create \
  --header 'Content-Type: <content-type>' \
  --header 'authorization: <api-key>' \
  --header 'x-access-id: <x-access-id>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-timestamp: <x-timestamp>' \
  --data '
{
  "type": "online",
  "name": "Lagos Fashion Store",
  "email": "lagosfashion@store.com",
  "phoneNumber": "0123246784824",
  "location": "Lagos",
  "country": "Nigeria",
  "avatar": "https:///imagesamp.lo.co",
  "currency": "NGN",
  "password": "12345678"
}
'
{
  "status": "success",
  "message": "success",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "location": "<string>",
    "country": "<string>",
    "active": true,
    "agentId": "<string>",
    "merchantId": "<string>",
    "currency": "<string>",
    "totalSales": "<string>",
    "defaultFiatCurrency": {
      "currency": "<string>",
      "useSystemRate": true,
      "rate": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

​
Headers

​
authorization
string
required
Base64-encoded HMAC-SHA256 signature of the request payload using the API secretMinimum string length: 1Example: "5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62e-ce7526d36296237663ad1f06f62a730c0466516507196b3ce6567493c-c52a7cf63d"
​
x-timestamp
string
required
Current timestamp in ISO 8601 formatExample: "2025-03-15T09:45:53.000Z"
​
x-request-id
string
required
Unique identifier for the request (UUID v4)Example: "550e8400-e29b-41d4-a716-446655440000"
​
x-access-id
string
required
Your API access ID provided by TenderExample: "your-access-id-here"
​
Content-Type
string
required
Media type of the request bodyExample: "application/json"

​
Body

​
type
string
required
Agent type (e.g. online, whatsapp, pos)Example: "online"
​
name
string
required
Display name of the agent or sub-businessExample: "Lagos Fashion Store"
​
email
string
required
Email address of the agentExample: "lagosfashion@store.com"
​
phoneNumber
string
Phone number of the agent. Required for WhatsApp agents only.Example: "0123246784824"
​
location
string
required
Location of the agentExample: "Lagos"
​
country
string
required
Country where the agent is locatedExample: "Nigeria"
​
avatar
string
URL of the agent’s avatar imageExample: "https:///imagesamp.lo.co"
​
currency
string
required
Default currency for the agent (e.g. ISO 4217 code)Example: "NGN"
​
password
string
Login password for the agent. Required for POS agents only.Example: "12345678"

​
Response

​
status
string
required
Status of the API requestExample: "success"
​
message
string
required
Human-readable message describing the resultExample: "success"
​
data
object
required
The created agent object containing all agent information

​
Response

​
status
string
required
Status of the API requestExample: "success"
​
message
string
required
Human-readable message describing the resultExample: "success"
​
data
object
required
Container object for the agents list and pagination data

Authorizations

​
authorization
string
header
required

HMAC-SHA256 signature. Required headers: x-access-id, x-request-id (UUID), x-timestamp (ISO), authorization (HMAC signature)

Headers

​
authorization
string
required

Base64-encoded HMAC-SHA256 signature of the request payload using the API secret

​
x-timestamp
string<date-time>
required

Current timestamp in ISO 8601 format

​
x-request-id
string<uuid>
required

Unique identifier for the request (UUID v4)

​
x-access-id
string
required

Your API access ID provided by Tender

​
Content-Type
string
required

Media type of the request body

Body

application/json
​
type
string
required

Agent type (e.g. online, whatsapp, pos)

Example:

"online"

​
name
string
required

Display name of the agent or sub-business

Example:

"Lagos Fashion Store"

​
email
string<email>
required

Email address of the agent

Example:

"lagosfashion@store.com"

​
location
string
required

Location of the agent

Example:

"Lagos"

​
country
string
required

Country where the agent is located

Example:

"Nigeria"

​
currency
string
required

Default currency for the agent (e.g. ISO 4217 code)

Example:

"NGN"

​
phoneNumber
string

Phone number of the agent (required for WhatsApp agents only)

Example:

"0123246784824"

​
avatar
string

URL of the agent's avatar image

Example:

"https:///imagesamp.lo.co"

​
password
string

Login password for the agent (required for POS agents only)

Example:

"12345678"

Response

200 - application/json

Agent created successfully

​
status
string
Example:

"success"

​
message
string
Example:

"success"

​
data
object