{ "openapi": "3.1.0", "info": { "title": "RemittancePulse API", "description": "Global remittance intelligence API covering the $700B+ annual global remittance market. 8 endpoints: corridor analysis (200+ corridors), provider comparison with true total cost (fee + FX markup), live ECB mid-market rate vs markup analysis, receive-country guides, mobile money ecosystem (M-Pesa/GCash/bKash/MTN MoMo/Wave), compliance and KYC intelligence, industry news, and diaspora community intelligence. Provider comparison and rate endpoints include Wise/Remitly/Western Union/Xoom affiliate links (corridor-aware). All require x402 micropayment (USDC on Base).", "version": "1.1.0", "contact": { "url": "https://remittancepulse.vercel.app" } }, "servers": [{ "url": "https://remittancepulse.vercel.app" }], "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "PAYMENT-SIGNATURE", "description": "x402 micropayment signature. Omit to receive 402 with payment requirements. Sign and retry to receive data." } } }, "paths": { "/api/remit/corridor": { "get": { "summary": "Corridor intelligence", "description": "Best providers, fees, exchange rates, delivery options, and receive methods for any send corridor. Includes World Bank benchmark cost comparison and corridor-specific tips.", "operationId": "remitCorridor", "security": [{ "x402": [] }], "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Sending country — e.g. USA, UAE, UK, Canada, Germany" }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Receiving country — e.g. Philippines, India, Mexico, Nigeria, Bangladesh" }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Amount to send in source currency" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Corridor analysis with top providers and receive options" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/remit/compare for provider side-by-side cost comparison" } }, "/api/remit/compare": { "get": { "summary": "Provider comparison", "description": "Side-by-side provider comparison showing true total cost (fee + FX markup). Uses live ECB mid-market rate as benchmark. Shows exactly how much the recipient gets with each provider.", "operationId": "remitCompare", "security": [{ "x402": [] }], "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Amount to send (default: 500)" }, { "name": "from_currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "e.g. USD, GBP, EUR, AED, CAD" }, { "name": "to_currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "e.g. PHP, INR, MXN, NGN, PKR" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Provider comparison with recipient amount and true cost ranking" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Pair with /api/remit/rate for live mid-market benchmark; response includes Wise/Remitly/WU affiliate links for immediate action" } }, "/api/remit/rate": { "get": { "summary": "FX rate and markup analysis", "description": "Live ECB mid-market rate for any currency pair with provider markup analysis. Shows the hidden cost of exchange rate markups in dollar terms.", "operationId": "remitRate", "security": [{ "x402": [] }], "parameters": [ { "name": "from_currency", "in": "query", "required": true, "schema": { "type": "string" }, "description": "e.g. USD, GBP, EUR, AED — also accepts 'from'" }, { "name": "to_currency", "in": "query", "required": true, "schema": { "type": "string" }, "description": "e.g. PHP, INR, MXN, NGN — also accepts 'to'" }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "FX rate intelligence with live rate and provider markup analysis" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.05, "x-agent-use-case": "on-demand", "x-agent-chaining": "Response includes provider affiliate links; follow with /api/remit/compare for full fee comparison" } }, "/api/remit/receive": { "get": { "summary": "Receive-country guide", "description": "How recipients can best receive money in a specific country — mobile wallets, cash pickup networks, bank transfer options, ID requirements, and local infrastructure overview.", "operationId": "remitReceive", "security": [{ "x402": [] }], "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" }, "description": "bank | cash | mobile | wallet — or omit for all methods" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Receive-country guide with platform specifics" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand" } }, "/api/remit/mobile": { "get": { "summary": "Mobile money ecosystem", "description": "Mobile money platforms by country or region — M-Pesa, GCash, bKash, MTN MoMo, Airtel Money, Wave, OPay, STC Pay and more. Includes how to receive international remittances, cashout options, and interoperability.", "operationId": "remitMobile", "security": [{ "x402": [] }], "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" }, "description": "East Africa | West Africa | South Asia | Southeast Asia | Latin America | Middle East" }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Specific platform — e.g. M-Pesa, GCash, bKash" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Mobile money ecosystem intelligence" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand" } }, "/api/remit/compliance": { "get": { "summary": "Compliance and KYC intelligence", "description": "KYC requirements, send limits, AML reporting thresholds, and corridor-specific restrictions. Covers FinCEN (US), FINTRAC (Canada), FCA (UK), AUSTRAC (Australia), and destination-country rules.", "operationId": "remitCompliance", "security": [{ "x402": [] }], "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Compliance intelligence with KYC tiers and corridor restrictions" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand" } }, "/api/remit/news": { "get": { "summary": "Remittance industry news", "description": "Real-time regulatory changes, provider launches, fee trend data, FATF updates, corridor alerts, and technology developments (stablecoin remittances, mobile money expansion).", "operationId": "remitNews", "security": [{ "x402": [] }], "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "schema": { "type": "string" }, "description": "regulatory | providers | fees | technology | all" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remittance news intelligence" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "scheduled" } }, "/api/remit/diaspora": { "get": { "summary": "Diaspora community intelligence", "description": "Community-specific remittance intelligence — preferred providers, cultural sending patterns, seasonal spikes (Eid, Christmas, Diwali), community trust factors, and optimized strategies for Filipino OFW, Indian expat, Mexican, Nigerian, Pakistani, and other diaspora communities.", "operationId": "remitDiaspora", "security": [{ "x402": [] }], "parameters": [ { "name": "community", "in": "query", "required": true, "schema": { "type": "string" }, "description": "e.g. Filipino, Indian, Mexican, Nigerian, Pakistani, Bangladeshi, Vietnamese" }, { "name": "sending_from", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country sending from — tailors corridor-specific advice" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Diaspora community remittance intelligence" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand" } } } }