API Documentation

Appearance

API Overview ​

The Web3 Portal API provides a RESTful interface for managing merchant USDT settlements across ERC20 and TRC20 networks.

Base URL ​

https://dev-crypto-portal.kesspay.io

API Version ​

Current version: v1

All API endpoints are prefixed with /api/v1 to support versioning.

Request Format ​

All requests should:

  • Use HTTPS
  • Include proper authentication headers
  • Send JSON payloads for POST requests with Content-Type: application/json

Response Format ​

All responses follow a consistent structure:

Success Response ​

json
{
  "success": true,
  "message": "Operation successful",
  "data": {
    // Response data here
  }
}

Error Response ​

json
{
  "success": false,
  "message": "Human-readable error message",
  "errors": null
}

For validation errors (422), the errors field contains field-specific errors:

json
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "amount": [
      "The amount field is required."
    ]
  }
}

Available Endpoints ​

EndpointMethodDescription
/api/v1/balanceGETGet merchant balance
/api/v1/payinsPOSTGenerate a customer-facing payment QR

Request Uniqueness ​

POST /api/v1/payins accepts an optional out_trade_no parameter that must be unique per merchant. Supplying this value lets you safely retry a request without creating duplicate invoices because the API will return a validation error if the identifier was already used.

Networks ​

The platform supports two USDT networks:

ERC20 (Ethereum) ​

  • Addresses start with 0x
  • Requires ETH for gas fees
  • More widely supported
  • Higher transaction fees

TRC20 (Tron) ​

  • Addresses start with T
  • Uses TRON energy and bandwidth
  • Typically faster and cheaper
  • Lower transaction fees

Next Steps ​