Quick Start Guide

Introduction:

Instant Cash Developer portal offers our Agents the ability to test our API's. This guide will detail how agents can create an account, get credentials to start testing within our sand box or connect directly to our Production environment. There are a variety of APIs available, so let’s get you started with the process.

Authentication

  1. IC API uses OAuth 2.0 access to authenticate requests. Developers who need to consume our APIs must include a valid subscription key in HTTP requests when calling our APIs. Without a valid subscription key the calls are:

    • Rejected immediately by API Management gateway and/or not forwarded to the back end services.

Sign up

  1. Sign up as a Guest user by clicking here

  2. After signing up, as a guest user you will be able to access and view our API documentation

  3. We offer array of APIs with detailed descriptions to enable you to select the API most applicable to your use case.

    • Reference APIs (view our network of Cities, States, Countries and delivery modes accessible in various receiving countries)

    • Transaction API (view Send transaction, Receive transaction, transaction status and details)

Test our APIs

As a Guest User:

As a Guest User, test credentials are available to you to immediately start testing our API's.

  1. Endpoints can be viewed and tested by accessing API documentation

    • Search from the Product list "Instant Cash API - Sandbox (Trial)"

    • Select the end point of your choice and select "Try it"

  2. During request initiation, The Developer Portal will requests a token from our CIAM using app registration client id and client secret.

    • As a user you will be challenged to prove your identity by supplying Developer User Credentials found via API Keys

    • Under the Authorisation Header, Select "Authorization_Code" under the dropdown the subscription key "authorization_code"

    • Once “ Authorization_Code” is selected, a pop-up screen will display.

    • Enter the Developer User Credentials

  3. After successful validation, CIAM will issue you a access/refresh token to test the endpoints.

  4. User makes an API call with the authorization header using Agent credentials and the token gets validated by using validate-jwt policy in APIM by Azure AD.

  5. Based on the validation result, the user will receive the response in the developer portal

  6. Once your routines are fine-tuned within the sandbox environment, you may initiate live transactions.

Ready to go live

  1. Contact our sales team info@instantcashworldwide.com to become an official agent today

    • Request to initiate the onboarding process as a UAT or PROD user.

    • New Developer Credentials will be issued to you where you can initiate requests via Postman or a platform of your choice.