API Documentation

Uweb3Bank API

Create, fund, and manage Premium virtual cards programmatically with our RESTful API

Last updated: October 2025 | Version 2.0

Getting Started

All API endpoints require proper authentication. Contact our sales team at sales@uweb3bank.com to obtain your API credentials.

Base URL

https://api.uweb3bank.com/v2

Authentication

Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Premium Card API

POST/cards/create

Create a new Premium virtual card

Request Body

{
  "cardholder_name": "John Doe",
  "bin": "493875",
  "currency": "USD",
  "initial_balance": 100.00,
  "metadata": {
    "user_id": "user_123",
    "purpose": "online_shopping"
  }
}

Response

{
  "success": true,
  "card": {
    "card_id": "card_abc123xyz",
    "card_number": "4938 7520 **** 1234",
    "cvv": "***",
    "expiry": "12/28",
    "cardholder_name": "John Doe",
    "balance": 100.00,
    "currency": "USD",
    "status": "active",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

POST/cards/fund

Add funds to an existing card

Request Body

{
  "card_id": "card_abc123xyz",
  "amount": 50.00,
  "currency": "USD",
  "crypto_payment": {
    "token": "USDT",
    "network": "TRC20",
    "tx_hash": "0x..."
  }
}

Response

{
  "success": true,
  "transaction": {
    "transaction_id": "txn_xyz789",
    "card_id": "card_abc123xyz",
    "amount": 50.00,
    "new_balance": 150.00,
    "status": "completed",
    "timestamp": "2025-01-15T11:00:00Z"
  }
}

GET/cards/:card_id

Retrieve card details and current balance

Response

{
  "success": true,
  "card": {
    "card_id": "card_abc123xyz",
    "card_number": "4938 7520 **** 1234",
    "cardholder_name": "John Doe",
    "balance": 150.00,
    "currency": "USD",
    "status": "active",
    "created_at": "2025-01-15T10:30:00Z",
    "last_transaction": "2025-01-15T11:00:00Z"
  }
}

GET/cards/:card_id/transactions

Get transaction history for a card

Response

{
  "success": true,
  "transactions": [
    {
      "transaction_id": "txn_xyz789",
      "type": "funding",
      "amount": 50.00,
      "balance_after": 150.00,
      "timestamp": "2025-01-15T11:00:00Z",
      "status": "completed"
    },
    {
      "transaction_id": "txn_abc456",
      "type": "purchase",
      "amount": -25.50,
      "merchant": "Amazon",
      "balance_after": 124.50,
      "timestamp": "2025-01-15T12:30:00Z",
      "status": "completed"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 2
  }
}

PATCH/cards/:card_id/status

Freeze or unfreeze a card

Request Body

{
  "status": "frozen" // or "active"
}

Response

{
  "success": true,
  "card": {
    "card_id": "card_abc123xyz",
    "status": "frozen",
    "updated_at": "2025-01-15T13:00:00Z"
  }
}

Error Codes

Code	Description
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid API key
`403`	Forbidden - Insufficient permissions
`404`	Not Found - Card or resource not found
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error - Contact support

Rate Limits

API requests are rate-limited to ensure fair usage and system stability:

Standard: 100 requests per minute
Card Creation: 10 cards per minute
Funding: 20 transactions per minute

Rate limit headers are included in all responses. Contact sales for higher limits.

Need Help?

Our technical team is here to help you integrate Uweb3Bank API into your application.

Technical Support Request API Access

{ "success": true, "card": { "card_id": "card_abc123xyz", "card_number": "4938 7520 **** 1234", "cvv": "***", "expiry": "12/28", "cardholder_name": "John Doe", "balance": 100.00, "currency": "USD", "status": "active", "created_at": "2025-01-15T10:30:00Z" } }

{ "success": true, "transaction": { "transaction_id": "txn_xyz789", "card_id": "card_abc123xyz", "amount": 50.00, "new_balance": 150.00, "status": "completed", "timestamp": "2025-01-15T11:00:00Z" } }

{ "success": true, "card": { "card_id": "card_abc123xyz", "card_number": "4938 7520 **** 1234", "cardholder_name": "John Doe", "balance": 150.00, "currency": "USD", "status": "active", "created_at": "2025-01-15T10:30:00Z", "last_transaction": "2025-01-15T11:00:00Z" } }

{ "success": true, "transactions": [ { "transaction_id": "txn_xyz789", "type": "funding", "amount": 50.00, "balance_after": 150.00, "timestamp": "2025-01-15T11:00:00Z", "status": "completed" }, { "transaction_id": "txn_abc456", "type": "purchase", "amount": -25.50, "merchant": "Amazon", "balance_after": 124.50, "timestamp": "2025-01-15T12:30:00Z", "status": "completed" } ], "pagination": { "page": 1, "per_page": 50, "total": 2 } }

Code

Description

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid API key

403

Forbidden - Insufficient permissions

404

Not Found - Card or resource not found

429

Too Many Requests - Rate limit exceeded

500

Internal Server Error - Contact support