Welcome to Inter API v2.0
🎉 Documentation v2.0 is now available!
This version includes comprehensive integration examples, SOAP request/response samples, and detailed payment method documentation.
This version includes comprehensive integration examples, SOAP request/response samples, and detailed payment method documentation.
🚀 What's New
- Complete Integration Examples - Real-world JavaScript code snippets
- SOAP Request/Response Examples - 3+ examples per method
- Error Handling - Detailed error codes with resolutions
- Best Practices - 5+ integration best practices per method
- Payment Methods - ACH, FedWire, FedNow, PIX, TED/DOC documentation
- Country-Specific Notes - Brazil and United States
📚 Core Methods
Pre-Transaction
- GetActiveCountries - List supported countries
- GetCurrencyTypesOfPayment - Get payment methods
- GetRatesAndCosts - Calculate rates and fees
Transaction
- CreateNewOrder - Create remittance order
- GetOrderStatus - Check order status
- GetOrderDetails - Get complete order info
- CancelOrder - Cancel an order
Reporting & Reconciliation
- GetPaymentsByDate - Daily reconciliation
- GetCancelationsByCanceledDate - Canceled orders
🌍 Supported Payment Methods
🇧🇷 Brazil
- PIX (ID=42) - Instant (5-30 min), 24/7
- TED/DOC (ID=31) - Traditional (30-120 min)
🇺🇸 United States
- ACH (ID=449) - 1-3 business days, economical
- FedWire (ID=784) - Same-day transfer
- FedNow (ID=783) - Instant, 24/7 (NEW!)
🔒 Security & Connection
Authentication Method
Our API uses SOAP Headers for authentication:
- Uses
AuthHeaderwithUserNameandPasswordin the SOAP Header - All requests must be sent over HTTPS
- See Getting Started for detailed implementation
IP Whitelisting
We use IP Whitelist for additional security:
- You must provide your IP range for configuration on our test and production servers
- No VPN configuration required
- Contact support to whitelist your IPs
🧪 Testing & Credentials
Test Environment Setup
To get started with testing:
- We will create the test user for you
- Provide your email address to receive credentials
- Test examples are available in the documentation for PIX, TED, and USA transactions
- UAT environment:
https://test.masspayments.inter.co/partner/api/mts.asmx
📧 Need credentials? Contact us at remittance@inter.co with your email address to receive test credentials.
🚫 Restricted Countries
The following countries are restricted as origin countries for sending transactions (applicable to both Brazil and USA):
⚠️ Restricted Origin Countries:
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)
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)
🔄 Transaction Reversal
Yes, it is possible to reverse a transaction using the CancelOrder method:
- Cancel orders before they are paid
- Reverse transactions in case of errors
- Handle compliance issues
- See CancelOrder documentation for details
📞 Support
- Email: remittance@inter.co
- Email: marcos.lanzoni@inter.co
- Production Support: 24/7 availability
- UAT Support: Monday-Friday, 8:00-20:00 (Brazil time, UTC-3)