Guides

Troubleshooting and Support

Suggest Edits

Common Issues and Solutions

When working with the IC API, you may encounter common issues related to authentication, request formatting, or response handling.
Here are some common problems and their respective solutions:

  • Authentication errors: Ensure that you are using a valid API key and including it correctly in the request header. Make sure your API key and the authentication method are specified in the API documentation.
  • Request formatting errors: Make sure your API requests are formatted correctly, with the appropriate headers, parameters, and request body. Review the API documentation and examples for guidance on proper request formatting.
  • Handling API responses: Ensure that your application can handle the different types of API responses, including successful responses, error messages, and edge cases. Implement error handling and retry mechanisms to manage API errors gracefully.

All errors have the same schema, therefore, the response body object remains consistent across all endpoints. Below are some examples of common error message:

Error code can be empty value or one of the following:

  • InternalServerError
  • ModelValidationError
  • ForbiddenPayoutNetworks
  • InvalidTransactionStatus
  • IpAddressNotAllowed
  • InvalidMode
  • PasswordRequired
  • InvalidAgentCode
  • InvalidICTCNumber

Note: "Authorization Required" is a common error that developers encounter when first exploring the Instant Cash REST APIs. The issue derives from incorrect API headers:

  • x-fapi-financial-id:
  • Authorization: Basic <base64UrlEncoded(user_id:password)>

Debugging Tips

Debug your IC API integration to identify and resolve issues quickly. Here are some tips for effective debugging:

  • Use logging to track API requests and responses, as well as any errors that occur during the integration process.
  • Test your integration using a variety of inputs and scenarios to ensure that it can handle different types of transactions and edge cases.
  • Use debugging tools and libraries for your programming language or platform to gain insights into the inner workings of your application and identify issues.

Frequently Asked Questions (FAQ)

The IC API website features a Frequently Asked Questions (FAQ) section that provides answers to common questions about the API, its usage, and integration. This section can be a helpful resource when troubleshooting issues or looking for quick answers to your questions.

Getting Support

If you need help with your IC API integration, consider the following support options:

  • Consult the API documentation, FAQs, and troubleshooting guides for assistance with common issues and best practices.
  • If you have any questions or need assistance with the IC API, you can contact the Instant Cash Partner Implementation team via email at [email protected].

Updated 8 months ago