API Reference

GET /api/v1/compare?from_country=US&to_country=NG&send_amount=200 HTTP/1.1
Host: ayasend.com
X-API-Key: aya_live_your_key_here

GET /api/v1/compare?from_country=US&to_country=NG&send_amount=200¤cy=USD HTTP/1.1
Host: ayasend.com
X-API-Key: aya_live_your_key_here

{
  "request": {
    "request_id": "a3f9b21c-...",
    "quoted_at": "2026-04-22T14:30:00Z",
    "platform": "api",
    "duration_ms": 312
  },
  "corridor": {
    "from_country": "United States",
    "to_country": "Nigeria",
    "send_currency": "USD",
    "receive_currency": "NGN",
    "send_amount": 200.0,
    "quote_mode": "send"
  },
  "best_option": {
    "provider": "Wise",
    "provider_id": "wise",
    "rank": 1,
    "receive_amount": 327841.0,
    "receive_currency": "NGN",
    "fx_rate": 1640.2,
    "fee": 3.50,
    "fee_display": "$3.50",
    "speed_label": "Within minutes",
    "payout_methods": ["bank_transfer", "mobile_wallet"],
    "confidence_score": 95,
    "source_badge": "Live API",
    "reason": "Best rate · high data confidence",
    "redirect_url": "https://wise.com/...",
    "logo_url": "/static/img/providers/wise.svg"
  },
  "alternatives": [
    {
      "provider": "Remitly",
      "provider_id": "remitly",
      "rank": 2,
      "receive_amount": 321200.0,
      "receive_currency": "NGN",
      "fx_rate": 1606.0,
      "fee": 0.0,
      "fee_display": "FREE",
      "speed_label": "Within minutes",
      "payout_methods": ["bank_transfer", "mobile_wallet"],
      "confidence_score": 80,
      "source_badge": "Scraped",
      "reason": "No transfer fee · competitive rate",
      "redirect_url": "https://remitly.com/...",
      "logo_url": "/static/img/providers/remitly.svg"
    }
  ],
  "recommendation_summary": {
    "best_rate": "Wise",
    "best_rate_amount": 327841.0,
    "lowest_fee": "Remitly",
    "lowest_fee_value": 0.0,
    "fastest": "Wise"
  }
}

import requests

API_KEY = "aya_live_your_key_here"
BASE_URL = "https://ayasend.com/api/v1"

def get_best_remittance(from_country, to_country, amount, currency="USD"):
    """
    Get the best remittance option for a corridor.
    Returns the best_option dict from AyaSend.
    """
    response = requests.get(
        f"{BASE_URL}/compare",
        params={
            "from_country": from_country,
            "to_country":   to_country,
            "send_amount":  amount,
            "currency":     currency,
        },
        headers={"X-API-Key": API_KEY},
        timeout=10
    )
    response.raise_for_status()
    data = response.json()
    return data["best_option"]


# Example: Show a worker their best option for $200 USD → Nigeria
best = get_best_remittance("US", "NG", 200)
print(f"Send via: {best['provider']}")
print(f"Recipient gets: {best['receive_amount']:,.0f} {best['receive_currency']}")
print(f"Fee: {best['fee_display']}")
print(f"Speed: {best['speed_label']}")
print(f"Why: {best['reason']}")

const API_KEY = "aya_live_your_key_here";
const BASE_URL = "https://ayasend.com/api/v1";

async function getBestRemittance(fromCountry, toCountry, amount, currency = "USD") {
  const params = new URLSearchParams({ from_country: fromCountry, to_country: toCountry, send_amount: amount, currency });
  const res = await fetch(`${BASE_URL}/compare?${params}`, {
    headers: { "X-API-Key": API_KEY }
  });
  if (!res.ok) throw new Error(`AyaSend API error: ${res.status}`);
  const data = await res.json();
  return data.best_option;
}

// Example: Embed in a payroll platform
const best = await getBestRemittance("US", "NG", 200);
console.log(`Best option: ${best.provider}`);
console.log(`Worker receives: ${best.receive_amount.toLocaleString()} ${best.receive_currency}`);
console.log(`Reason: ${best.reason}`);