Frequently Asked Questions (FAQ)

How do I get started with the IC API?

To get started, sign up for an API key on the IC API website and review the API documentation for information on authentication, endpoints, and request parameters. You can then integrate the API into your application using the programming language and platform of your choice.

What is the IC API used for?

The IC API is used for facilitating money remittance transactions and allowing users to send and receive money quickly and securely through your application.
It can be integrated into various types of applications, such as e-commerce platforms, gig economy platforms, and charitable donation platforms.

What authentication method does the IC API use?

The IC API uses Basic Authentication, which requires a valid API key to be included in the request header. Additionally, other custom headers, such as the
subscription key and financial API headers, may be required for certain endpoints.

How do I handle multi-currency transactions with the IC API?

The IC API supports transactions in multiple currencies. When initiating a money transfer, specify the correct currency code for the transaction amount.
Exchange rates and fees may apply when sending money between different currencies. Obtain the current exchange rates and fees using an external API or a reliable financial data provider to provide accurate information to your users.

How can I stay informed about updates and changes to the IC API?

Stay informed about updates, changes, and new features related to the IC API by subscribing to the IC API newsletter, the blog, or joining the developer community. Staying up-to-date with the latest developments can help you take advantage of new features and ensure that your application remains compatible with the API as it evolves.

How do I get a subscription key?

Subscription key is provided by IC Operations team after completion of Sandbox testing. Subscription key is a required API header for IC REST APIs in UAT and Production environment.

What is a difference between Sandbox and UAT environments?

Sandbox environment is open to all users who wish to explore the Instant Cash REST API's capabilities. Credentials for UAT environment are provided by Instant Cash Operations team.
Despite that request and response body of Sandbox and UAT are the same, an additional query parameter is required for UAT environment: subscription-key.
Sandbox works only with specific pre-defined parameter values: https://docs.instantcashworldwide.com/edit/introductions-for-api-testing . UAT is the pre-production environment that is used to test applications before they are deployed to the Production. That is why, in Sandbox you can send transaction only to 3 countries and in UAT you can send transaction to all destination countries that are available in production.

I got no results for Sandbox, but Status=200 OK

It means that the request was successful and there were no errors on the server side. However, sandbox database does not contain any data for selected combination. Sandbox works only with pre-defined parameter values: API testing guide (instantcashworldwide.com)

I am a receiving partner. How should I test the receiving endpoints?

Step 1: Use the recipes to create a transaction : Recipes (instantcashworldwide.com)

Step 2: Review our guidelines with receiving endpoints: Receive Money (instantcashworldwide.com)

I received an error message: "Unable to extract agent data. Record limit exceeded. Download data using Admin interface" after calling “Get Agent List” endpoint with Destination country: India and Delivery Mode: 4.

Our database contains more than 160 000 records for third party arrangements in India. That’s why,

option 1: call “Get Agent list” endpoint, but narrow your search by “bankName” value (only uppercase letters)

option 2: call “Get Bank Branches” endpoint