TranSwap Api v1.8.8
Introduction
Welcome to the TranSwap API Reference!
At TranSwap, our goal is to simplify global payments and revolutionize how businesses handle cross-border transfers. We aim to make moving money internationally as effortless as sending a text or sharing a photo—fast, secure, cost-effective, and available whenever you need it.
Why Choose TranSwap?
In today’s global economy, businesses need a reliable partner to manage international transactions seamlessly. With TranSwap, you can confidently move money across borders, knowing that security, scalability, and reliability are built into every step of the process. Our platform is designed to be robust and flexible enough to meet your needs—whether you're processing hundreds of transfers or managing a few large transactions.
API Overview
The TranSwap API is organized around RESTful architecture, which makes it intuitive and easy to integrate into your existing systems. Here’s what you can expect:
- Consistent, predictable URLs: Our endpoints are structured logically around resources, making it easy to understand where to send requests.
- JSON responses: All responses are JSON-encoded, ensuring a lightweight and widely compatible format.
- Standard HTTP methods and codes: You’ll use familiar HTTP methods like GET, POST, and PUT, and receive standard response codes to easily track the success of your requests.
By leveraging the TranSwap API, you can:
- Automate currency conversions between your wallets.
- Request real-time exchange rates.
- Initiate money transfers with ease.
- Tap into many more features that streamline your cross-border financial processes.
We have prioritized security throughout every aspect of the platform—from the underlying system architecture to our development practices and the way we interact with partners. You can trust that your transactions are protected by world-class security measures.
We're excited to support you in building the best financial solutions for your business. This guide will provide everything you need to get started with our APIs, and we’re here to help you along the way.
If you need assistance, please don’t hesitate to contact our support team at support@transwap.dev.
Getting Started with TranSwap API
To get the most out of the TranSwap API, we recommend taking the time to explore the full documentation. Understanding the breadth of what TranSwap offers will help you maximize the efficiency and potential of your integration.
Steps to Get Started:
Familiarize Yourself with the API Documentation:
Take a moment to go through this guide to gain a complete understanding of our products and API capabilities. A thorough review will save you time and effort in the long run.Use the Postman Collection:
We offer a Postman collection that you can download and use to quickly familiarize yourself with how our APIs work. It’s a hands-on way to test different endpoints and see how they fit into your workflows.Check the Help Center:
For more information on the services we provide and how they can benefit your business, head to our Help Center.Stay Updated:
Subscribe to our developer mailing list to stay informed about new features, technical updates, and important changes.
Handling Errors
Our API uses standard HTTP response codes to indicate the outcome of your requests. Understanding these codes will help you troubleshoot and optimize your integration.
HTTP Status Codes:
| Code | Meaning |
|---|---|
200 |
OK - Your request was successfully processed. |
201 |
Created - A new resource was successfully created. |
400 |
Bad Request - There was an issue with the information you provided, such as missing or invalid parameters. |
401 |
Unauthorized - Your authentication token is missing or invalid. |
404 |
Not Found - The API endpoint you're trying to access does not exist. |
429 |
Too Many Requests - You've sent too many requests in a short period of time. Please slow down. |
500 |
Internal Server Error - There was an issue on our end. Please try again later. |
503 |
Service Unavailable - Our system is currently down for maintenance. Please try again later. |
By paying attention to these response codes, you can quickly identify whether your requests have been successful or if any further action is required.
Pagination Explained
When retrieving large sets of data, the TranSwap API offers pagination to make the process more efficient.
How it Works:
When you send a GET request to retrieve data, you can use the pageSize query parameter to set how many results you want to receive at once. This parameter has a default value of 10 and a maximum value of 50. If there are more results available than your pageSize allows, we include a nextPage link in the response. You can use this link to retrieve the next set of results.
This approach ensures that you can retrieve the data you need without overwhelming your system with too many results at once.
Environments: Sandbox vs Production
TranSwap offers two distinct environments to suit different stages of your integration:
Sandbox Environment: This is where we recommend you start. In the Sandbox, you can safely test your integration without affecting live transactions. You'll have access to pre-funded wallets and test money, allowing you to simulate real transfers without risk. If you ever need to reset your Sandbox account, just let us know.
Production Environment: Once you're confident that your integration is working as expected in the Sandbox, you're ready to go live in Production. The Production environment is where real transactions take place, so make sure everything is fully tested and secure before making the switch.
Important Note:
Sandbox balances are completely separate from your Production account. Any test transactions you make in Sandbox will not affect your live account.
API URLs
To access the TranSwap API, use the following URLs based on the environment you're working in:
| Environment | URL |
|---|---|
| Sandbox (Primary) | https://api.transwap.dev |
| Sandbox (Backup) | https://sandbox-apim-ts-asia-sg.developer.azure-api.net |
| Production | https://api.transwap.live |
By following this guide and taking advantage of the features and flexibility offered by TranSwap’s API, you can streamline your global payment processes and make international transactions as easy as possible for your business.
Should you have any further questions or need technical support, don’t hesitate to reach out. We’re here to help!