Documentation Index
Fetch the complete documentation index at: https://docs.peere.network/llms.txt
Use this file to discover all available pages before exploring further.
Merchant Management Schemas
API endpoints for onboarding and managing merchants within your provider platform.
Endpoints
| Method | Endpoint | Description |
|---|
| GET | /v1/provider/merchant | Get specific merchant details |
| GET | /v1/provider/merchants | List merchants with filters |
| POST | /v1/provider/merchants | Create merchants in batch |
| PATCH | /v1/provider/merchant | Update merchant information |
GET /v1/provider/merchant
Retrieve details for a specific merchant under your provider account.
Query Parameters
| Parameter | Type | Required | Description |
|---|
entityId | string | Yes | Merchant entity identifier |
Response Schema
{
"statusCode": 200,
"success": true,
"data": {
"id": "string",
"ref": "string",
"name": "string",
"email": "string",
"phone": "string",
"code": "string",
"providerId": "string",
"userType": "merchant",
"country": "string",
"state": "string",
"website": "string",
"description": "string",
"icon": "string",
"trusted": true,
"trustLevel": "basic | enhanced | premium"
}
}
GET /v1/provider/merchants
List all merchants under your provider account with optional filters.
Query Parameters
| Parameter | Type | Required | Description |
|---|
ids | string[] | No | Filter by merchant IDs |
trusted | boolean | No | Filter by trust status |
limit | number | No | Number of results to return |
offset | number | No | Number of results to skip |
Response Schema
{
"statusCode": 200,
"success": true,
"data": {
"merchants": [
{
"id": "string",
"name": "string",
"email": "string",
"trusted": true,
"trustLevel": "basic | enhanced | premium",
"createdAt": "string"
}
],
"total": 1
}
}
POST /v1/provider/merchants
Create multiple merchants in batch for your provider platform.
Request Body
{
"merchants": [
{
"name": "string",
"email": "string",
"phone": "string",
"address": "string",
"website": "string",
"description": "string"
}
]
}
Request Schema
| Field | Type | Required | Description |
|---|
merchants | array | Yes | Array of merchant objects |
merchants[].name | string | Yes | Merchant business name |
merchants[].email | string | Yes | Merchant email address |
merchants[].phone | string | No | Merchant phone number |
merchants[].address | string | No | Merchant business address |
merchants[].website | string | No | Merchant website URL |
merchants[].description | string | No | Merchant description |
Response Schema
{
"statusCode": 201,
"success": true,
"message": "Merchants created successfully",
"data": {
"created": 1,
"merchants": [
{
"id": "string",
"name": "string",
"email": "string",
"providerId": "string"
}
]
}
}
PATCH /v1/provider/merchant
Update information for an existing merchant.
Request Body
{
"entityId": "string",
"name": "string",
"email": "string",
"phone": "string",
"address": "string",
"website": "string",
"description": "string",
"icon": "string"
}
Request Schema
| Field | Type | Required | Description |
|---|
entityId | string | Yes | Merchant entity identifier |
name | string | No | Updated merchant name |
email | string | No | Updated email address |
phone | string | No | Updated phone number |
address | string | No | Updated business address |
website | string | No | Updated website URL |
description | string | No | Updated description |
icon | string | No | Updated icon URL |
Response Schema
{
"statusCode": 200,
"success": true,
"message": "Merchant updated successfully",
"data": {
"id": "string",
"name": "string",
"email": "string"
}
}
Merchant Schema (Sensitive Fields Hidden)
When retrieving merchant information as a provider, sensitive fields are hidden for security:
| Field | Type | Description |
|---|
id | string | Merchant identifier |
ref | string | Merchant reference code |
name | string | Business name |
email | string | Contact email |
phone | string | Contact phone |
code | string | Merchant code |
providerId | string | Provider identifier |
userType | string | Always “merchant” |
country | string | Country code |
state | string | State/region |
website | string | Website URL |
description | string | Business description |
icon | string | Business icon URL |
trusted | boolean | Trust status |
trustLevel | string | Trust level |
Error Responses
400 Bad Request
{
"statusCode": 400,
"success": false,
"message": "Invalid merchant data"
}
404 Not Found
{
"statusCode": 404,
"success": false,
"message": "Merchant not found"
}
409 Conflict
{
"statusCode": 409,
"success": false,
"message": "Merchant with this email already exists"
}
