IC API Sandbox
The IC API offers a sandbox environment for developers to test their integration and simulate different scenarios and error cases. In this section, we'll explore the features and benefits of the IC API sandbox environment, along with the steps involved in using it. However, this is optional and partners can directly integrate in UAT phase.
Benefits of the Sandbox Environment
The IC API sandbox environment provides several benefits for developers:
- Testing: The sandbox environment allows developers to test their integration with the API and ensure that it is functioning correctly.
- Simulation: Developers can use the sandbox environment to simulate different scenarios and error cases, such as compliance checks, rejections, and acceptances.
- Isolation: The sandbox environment is isolated from the production environment, so developers can test and experiment without affecting live transactions.
- Security: The sandbox environment provides a secure testing environment, with the same security protocols and features as the production environment.
Using the Sandbox Environment
To use the IC API sandbox environment сonsult the API Reference and guidelines for information on any differences or limitations in the sandbox environment. However, certain endpoints and features may not be available in the sandbox environment or may behave differently than in the production environment
Users and endpoints:
Different endpoints require different user types to successfully process a request. The below table illustrates which methods each user type triggers:
| Endpoint Name | User Access Level | Agent Type |
|---|---|---|
| Get Balance | First-Level / Single-Level | Sender / Both |
| Get Agent List | First-Level / Single-Level | Sender / Both |
| Get Updated Agent List | First-Level / Single-Level | Sender / Both |
| Get Anywhere Payout Network | First-Level / Single-Level | Sender / Both |
| Get Bank Branches | First-Level / Single-Level | Sender / Both |
| Get Cities | First-Level / Single-Level | Sender / Both |
| Get Exchange Rate | First-Level / Single-Level | Sender / Both |
| Get Charge Slab | First-Level / Single-Level | Sender / Both |
| Get Modalities | First-Level / Single-Level | Sender / Both |
| Get Receiving Countries | First-Level / Single-Level | Sender / Both |
| Get States | First-Level / Single-Level | Sender / Both |
| Get Transaction Details | First-Level / Single-Level | Sender / Both |
| Get Transaction Report | All | All |
| Get list of transactions | First-Level / Single-Level | Sender / Both |
| Generate ICTC | First-Level / Single-Level | Sender / Both |
| Create a transaction | First-Level / Single-Level | Sender / Both |
| Authorize temporary transaction | Supervisor | Sender / Both |
| Cancel a transaction | First-Level / Single-Level | Sender / Both |
| Modify a transaction | First-Level / Single-Level | Sender / Both |
| Change Password | All | All |
| Get Static Data | All | All |
| * Update Transaction Status | All | All |
| Get Outstanding Remittance | First-Level / Single-Level / Receiver | Receiver / Both |
| Get ICTC payment status | First-Level / Single-Level / Receiver | Receiver / Both |
| Receive Payment | First-Level / Single-Level / Receiver | Receiver / Both |
| Unlock a transaction | First-Level / Single-Level / Receiver | Receiver / Both |
| Confirm a transaction | First-Level / Single-Level / Receiver | Receiver / Both |
* - Applicable for Sandbox environment only.
Note:
- Ensure to integrate all the relevant methods listed above according to the type of partner/integration. In case you are not integrating a few methods, you must present the Business Cases while development. Once development and UAT are done, check list will be shared by IC OPS Team for signoff.
- In the future, new fields may be added to the response bodies of any endpoint. We recommend implementing your system in a flexible manner so that the addition of new fields does not break your integration. It is essential to design your system to accommodate these changes seamlessly to ensure continued functionality.
Important Notice for Sandbox Environment Users
Sandbox Environment is open for all users who want to experience Instant Cash REST APIs. It is designed strictly for testing purposes. We strongly advise against sending real data to the Sandbox, as it is not designed to handle sensitive or personal information. It is the API user's responsibility to protect their data by ensuring that no real information is transmitted to non-production environments. Failure to comply with this guideline may expose your data to risks. Please exercise due diligence and use this environment strictly within its designated boundaries to protect your information.
Updated 7 months ago