Overview

This document describes the RESTful API for Web3 Payment Gateway. The gateway enables the existing system to generate unique crypto deposit addresses, monitor blockchain transactions, and receive webhooks upon successful payments.

Base URL

<https://tmx-payment.tokenminds.co/api/v1>

Authentication

The API uses API-key for the authentication.

Machine-to-Machine (M2M)

Used by existing services to communicate with the Gateway.

• Mechanism: OAuth 2.0 Client Credentials Flow
• Header: X-API-Key: <api-key>

Conventions

Content-Type

All requests and responses use application/json.

Versioning

The API is versioned via the URL path (e.g., /api/v1/...).

Monetary Values

All crypto amounts are represented as stringified integers in the smallest unit (e.g., Wei for ETH, Satoshi for BTC) to avoid floating-point precision errors.

• Example: 1 USDC (6 decimals) = "1000000"

Rate Limiting

Global rate limits are enforced to prevent abuse.