API Documentation

Build voice-activated remittance features into your application with our developer-friendly API.

Base URL

https://api.remittease.xyz/v1

Key Features

Voice command processing

Stablecoin conversions

Real-time transfers

Webhook notifications

Authentication

RemittEase API uses API keys for authentication. Include your API key in the Authorization header.

Headers

Authorization: Bearer your_api_key_here
Content-Type: application/json

Get API Keys

Generate API keys from your RemittEase dashboard. Use test keys for development and live keys for production.

Voice API

POST /voice/process

Process voice commands and convert to transfer intent.

Request Body

{
  "audio_data": "base64_encoded_audio",
  "user_id": "user_12345",
  "voice_profile": "profile_abc123"
}

Response

{
  "status": "success",
  "intent": {
    "action": "transfer",
    "amount": 100,
    "currency": "USD",
    "recipient": "mom",
    "confidence": 0.98
  },
  "voice_verified": true
}

POST /voice/train

Train voice biometric model for user authentication.

Parameters

audio_samples - Array of base64 encoded voice samples
user_id - Unique user identifier
language - User's preferred language (optional)

Transfers

POST /transfers

Initiate a new transfer with automatic stablecoin conversion.

Request Body

{
  "amount": 100.00,
  "from_currency": "USD",
  "to_currency": "ZAR",
  "recipient": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+27123456789"
  },
  "payment_method": "bank_account",
  "reference": "Family support"
}

Response

{
  "transfer_id": "tx_7f8g9h0i1j",
  "status": "processing",
  "amount_sent": 100.00,
  "amount_received": 1850.00,
  "exchange_rate": 18.5,
  "fee": 0.50,
  "estimated_delivery": "2025-05-22T15:30:00Z",
  "stablecoin_used": "USDC"
}

GET /transfers/{transfer_id}

Get transfer status and details.

Response

{
  "transfer_id": "tx_7f8g9h0i1j",
  "status": "completed",
  "blockchain_tx": "0x1a2b3c4d...",
  "completed_at": "2025-05-22T15:25:30Z"
}

Stablecoins

GET /stablecoins/rates

Get current stablecoin exchange rates.

Response

{
  "rates": {
    "USDC": {
      "USD": 1.00,
      "ZAR": 18.5,
      "EUR": 0.92
    },
    "USDT": {
      "USD": 0.999,
      "ZAR": 18.48
    }
  },
  "updated_at": "2025-05-22T14:30:00Z"
}

POST /stablecoins/convert

Convert between stablecoins and fiat currencies.

Request Body

{
  "amount": 100,
  "from": "USD",
  "to": "USDC",
  "wallet_address": "0x742d35Cc6642C173a5B6A55FBe"
}

Webhooks

Receive real-time notifications about transfer status changes, voice authentication events, and system updates.

Webhook Events

transfer.created - New transfer initiated
transfer.processing - Transfer being processed
transfer.completed - Transfer completed successfully
transfer.failed - Transfer failed
voice.verified - Voice authentication successful
voice.failed - Voice authentication failed

Webhook Payload Example

{
  "event": "transfer.completed",
  "data": {
    "transfer_id": "tx_7f8g9h0i1j",
    "status": "completed",
    "amount": 100.00,
    "currency": "USD",
    "completed_at": "2025-05-22T15:25:30Z"
  },
  "timestamp": "2025-05-22T15:25:30Z"
}

Error Handling

HTTP Status Codes

200 - Success

400 - Bad Request

401 - Unauthorized

403 - Forbidden

429 - Rate Limited

500 - Server Error

Error Response Format

{
  "error": {
    "code": "VOICE_VERIFICATION_FAILED",
    "message": "Voice authentication failed. Please try again.",
    "details": {
      "confidence_score": 0.65,
      "required_score": 0.80
    }
  }
}

SDKs & Examples

JavaScript/Node.js

Official SDK with TypeScript support

npm install @remittease/sdk

Python

Python SDK with async support

pip install remittease

cURL Examples

Ready-to-use API examples

View Examples

Quick Start - JavaScript

import { RemittEase } from '@remittease/sdk';

const client = new RemittEase({
  apiKey: 'your_api_key',
  environment: 'sandbox' // or 'production'
});

// Process voice command
const result = await client.voice.process({
  audioData: audioBase64,
  userId: 'user_123'
});

// Create transfer
const transfer = await client.transfers.create({
  amount: 100,
  fromCurrency: 'USD',
  toCurrency: 'ZAR',
  recipient: {
    name: 'John Doe',
    email: 'john@example.com'
  }
});

Rate Limits

• Voice API: 100 requests per minute
• Transfers: 50 requests per minute
• General API: 1000 requests per hour
• Rate limits are per API key and reset every window

Need Help?

Join our developer community or contact our technical support team.

Developer Discord Technical Support