# GetActiveCountries Method
Overview
This method allows Client Applications to obtain a list of all Countries to which Inters currently sends remittances or offers different services and forms of payments.
Use Cases:
- Populate country dropdown in your UI
- Validate destination countries before creating orders
- Display available corridors to customers
- Cache reference data for your application
Performance: Typically responds in 50-100ms (highly cacheable)
Caching Recommendation: Cache this data for 24 hours and refresh daily.
🚫 Restricted Origin Countries
⚠️ Important: The following countries are restricted as origin countries for sending transactions to Brazil and USA. Transactions originating from these countries will be rejected.
Restricted Countries List:
| Country Code | Country Name |
|---|---|
| KP | North Korea |
| IR | Iran |
| MM | Myanmar |
| AF | Afghanistan |
| NI | Nicaragua |
| UA | Ukraine |
| ZW | Zimbabwe |
| CU | Cuba |
| CS | Serbia and Montenegro |
| MK | North Macedonia |
| CG | Congo |
| LB | Lebanon |
| ML | Mali |
| SS | South Sudan |
| SY | Syria |
| YE | Yemen |
| VE | Venezuela |
| LY | Libya |
| HT | Haiti |
| CF | Central African Republic |
| IQ | Iraq |
| SO | Somalia |
| SD | Sudan |
Note: This restriction applies to the SenderCountry field in transaction requests. Always validate the sender's country before submitting orders.
Request Fields
| Field Name | Type (Length) | Option | Description |
|---|---|---|---|
| AgentID | Integer (9) | R | Your agent ID |
| PartnerID | Integer (9) | R | Your partner ID |
| SenderCountry | Alpha (2) | R | ISO 3166-1 alpha-2 country code for origin (e.g., "US") |
Response Fields
The following table describes the fields available in the response or output to the GetActiveCountries request:
| Field Name | Type (Length) | Option | Description |
|---|---|---|---|
| CountryCode | Alpha (2) | R | Follows ISO 3166‐1 alpha‐2 Country Codes |
| CountryName | Alpha (50) | R | Country name in the English language |
Request Examples
Error Response Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Invalid Country of Origin</faultstring>
<detail>
<ErrorCode>1103</ErrorCode>
<ErrorMessage>SenderCountry must be a valid ISO 3166-1 alpha-2 code</ErrorMessage>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Integration Best Practices
1. Cache the Response
This data rarely changes, so cache it to improve performance:
// Cache for 24 hours
const CACHE_TTL = 24 * 60 * 60 * 1000;
async function getActiveCountries(senderCountry) {
const cacheKey = `active_countries_${senderCountry}`;
// Check cache first
const cached = await cache.get(cacheKey);
if (cached && cached.timestamp + CACHE_TTL > Date.now()) {
return cached.data;
}
// Fetch from API
const countries = await GetActiveCountries({
AgentID: 12345,
PartnerID: 100,
SenderCountry: senderCountry,
});
// Store in cache
await cache.set(cacheKey, {
data: countries,
timestamp: Date.now(),
});
return countries;
}
Testing
Display Transfer Information
┌─────────────────────────────────────────┐
│ Send money to Brazil 🇧🇷 │
├─────────────────────────────────────────┤
│ Available payment methods: │
│ • Bank Deposit (TED/DOC/PIX) │
│ • PIX (Instant) │
│ │
│ Processing time: 5-60 minutes │
│ Currency: Brazilian Real (BRL) │
└─────────────────────────────────────────┘
Related Methods
After getting active countries, you'll typically need:
- GetCurrencyTypesOfPayment - Get available payment methods
- GetRatesAndCosts - Calculate transfer costs
- CreateNewOrder - Create the transfer
Support
- remittance@inter.co
- marcos.lanzoni@inter.co