Welcome! In this document we will provide a high-level overview of what you can expect from this guide. We will go over what you need to get started, what you should expect to see in this guide, as well as the general flow of the ClickSWITCH process.
At the heart of the ClickSWITCH API is one main objective: Identifying targets (banks, employers, etc.) and helping customers "switch" the account information used to either deposit or withdraw money to/from these targets.
Performing a switch is different based on who the target is, what the type of switch it is, and many other factors. However, the ClickSWITCH API strives to make this process as simple and streamlined as possible.
In order to begin the process, you'll need to set up the customer in the ClickSWITCH API. Once the customer is set up you will ask the customer to identify the 'target' they want to switch to their new account (employer, social security or annuity payment, utility bill payments, etc).
Once you have this information and provide it to the ClickSWITCH API, we will then send you back a question or series of questions to ask the user based on what you've sent us. Because the process is different for each target and type, the data needed to successfully perform a switch will differ. The ClickSWITCH API becomes conversational at this point. We will send you what we need from the user, you will send it back, and then we will ask additional questions and expect additional responses until we have all the data we need. At this point we will let you know we have all the information we need and allow you to review that information is correct and confirm you want to perform that switch with the information provided.
In this guide we will run through a real-world example of how the ClickSWITCH API might be used in a customer app to perform a direct deposit switch. We will break this process down into six steps:
- Create a customer
- Select a type
- Select a target
- Create a switch
- Finalize the switch
Before getting started you will need to obtain a ClickSWITCH API key. You can do this by contacting ClickSWITCH directly and requesting a key. This API key should be sent in the
header of each request with a key of
api-key. If you do not pass up this API key in the
header of each request you will receive a
400 error from the server.
Along with our real-world guide, detailed documentation for each of our API endpoints is available in our SwaggerHub so that you can take a more in-depth look at what is available through the ClickSWITCH API. Click on the "SwaggerHub" link in the sidebar on the left-hand side of your screen to see more.
Now that you have an API key you're ready to start creating customers and switches! Click on the link below or the "Setup" link in the sidebar in order to start learning how this process might look in a real-world scenario.