Skip to main content

API Endpoints Overview

Complete list of all available API endpoints organized by category.

1. Authentication​

Get Access Token​

POST /o/token/

Obtain an OAuth2 access token using client credentials flow.

Required Parameters:

  • grant_type: "client_credentials"
  • scope: "read write"

View Details →

Revoke Access Token​

POST /o/revoke_token/

Revoke an access token before it expires.

List OAuth Applications​

GET /o/apps/

List all OAuth applications associated with your account.

2. Payments​

Create Payment​

POST /payments/

Create a new cryptocurrency payment request.

Required Parameters:

  • price_amount: Amount in USD
  • price_currency: "USD"
  • pay_currency: Cryptocurrency code (e.g., "USDTERC20")

Alternative (using blockchain/token):

  • blockchain: "ETH", "POLYGON", "TRON", etc.
  • token: "USDT", "USDC", "ETH", etc.

View Details →

Get Payment Details​

GET /payments/{transaction_id}/

Retrieve detailed information about a specific payment.

View Details →

List All Payments​

GET /payments/

List all payments with optional filtering and pagination.

Query Parameters:

  • page, page_size
  • status, order_id
  • created_after, created_before

View Details →

Update Payment​

PATCH /payments/{transaction_id}/

Update payment metadata (order_id, description, callback_url).

Cancel Payment​

POST /payments/{transaction_id}/cancel/

Cancel a pending payment (only if no deposits received).

Estimate Payment Amount​

POST /payments/estimate/

Calculate the exact cryptocurrency amount for a payment.

View Details →

3. Wallets​

List Wallets​

GET /wallets/

List all wallet accounts in your organization.

Create Wallet​

POST /wallets/

Create a new wallet for fund segregation.

Required Parameters:

  • name: Wallet display name

Get Wallet Details​

GET /wallets/{wallet_id}/

Get detailed information about a specific wallet.

Update Wallet​

PATCH /wallets/{wallet_id}/

Update wallet settings.

Delete Wallet​

DELETE /wallets/{wallet_id}/

Delete a wallet (must have zero balance).

Get Wallet Balance​

GET /wallets/{wallet_id}/balance/

Get current balance for a specific wallet.

4. Withdrawals​

Create Withdrawal​

POST /withdrawal/

Create a new withdrawal request.

Required Parameters:

  • amount: Amount to withdraw
  • currency: Cryptocurrency code
  • address: Destination address

View Details →

Get Withdrawal Details​

GET /withdrawal/{withdrawal_id}/

Get detailed information about a specific withdrawal.

List All Withdrawals​

GET /withdrawal/

List all withdrawals with optional filtering.

View Details →

Cancel Withdrawal​

POST /withdrawal/{withdrawal_id}/cancel/

Cancel a pending withdrawal.

Get Withdrawal Limits​

GET /withdrawal/limits/

Get withdrawal limits and fees for all currencies.

5. Currencies & Rates​

List Supported Currencies​

GET /currencies/

Get all supported cryptocurrencies with details.

View Details →

Get Exchange Rates​

GET /rates/

Get current exchange rates for all cryptocurrencies.

View Details →

Get Specific Rate​

GET /rates/{currency}/

Get exchange rate for a specific cryptocurrency.

Calculate Exchange Amount​

POST /rates/calculate/

Calculate exchange amount between currencies.

Required Parameters:

  • amount: Amount to convert
  • from_currency: Source currency
  • to_currency: Target currency

6. User & Settings​

Get User Info​

GET /user/me/

Get information about the authenticated user/tenant.

Get Account Balances​

GET /user/balances/

Get aggregated balance across all wallets.

Get Balance History​

GET /user/balances/history/

Get balance history and transaction volume.

Get Platform Fees​

GET /user/fees/

Get platform fee configuration.

Get Webhook Settings​

GET /user/webhooks/

Get webhook configuration.

Update Webhook Settings​

PATCH /user/webhooks/

Update webhook configuration.

Updatable fields:

  • webhook_url: Default webhook URL
  • webhook_secret: Secret for signatures
  • enabled_events: Array of events

Test Webhook​

POST /user/webhooks/test/

Send a test webhook to verify configuration.

7. Transaction History​

List Transaction History​

GET /transactions/transactions/

Get comprehensive transaction history.

Query Parameters:

  • type: "payment" or "withdrawal"
  • status, currency
  • date_from, date_to

View Details →

Export Transactions (Optional)​

POST /transactions/export/

Export transaction history for accounting.

Get Transaction Stats (Optional)​

GET /transactions/stats/

Get transaction statistics and analytics.

8. System & Status​

API Status​

GET /status/

Check API system status (no authentication required).

View Details →

Get Maintenance Info (Optional)​

GET /maintenance/

Get information about scheduled maintenance.

Response Format​

All API responses follow a consistent format:

Success Response:

{
  "field": "value",
  "nested": {
    "data": "here"
  }
}

Error Response:

{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "details": {
      "field": "Additional details"
    }
  }
}

Authentication​

All endpoints (except /status/ and /maintenance/) require OAuth 2.0 authentication:

curl -H "Authorization: Bearer your_access_token" \
     {{BASE_URL}}/endpoint/

Rate Limits​

  • Default: 1000 requests per hour
  • Payment creation: 100 per hour
  • No limit on webhook notifications

Webhook Events​

Available webhook events:

  • payment_status_update - Payment status changed
  • withdrawal_status_update - Withdrawal status changed
  • deposit_received - Incoming deposit detected
  • deposit_merged - Deposit merged to main wallet

View Webhook Reference →