Getting Started
Setting up Your Sandbox
- 1.
2. Finish On-Boarding. This step might feel onerous, but behind the scenes, it gives us the information we need to enable the appropriate features for you on sandbox. KYC information supplied here can be fake or real. If it is real, we can use this information to enable production access for you when you are ready to go live with us. If fake, you will need to finish the same setup on our production application. This guide gives a good overview of how to finish onboarding.
That's it! Now you have everything you need to be able to start playing with Synapse's APIs.
Start Building
We usually recommend downloading Postman and getting a feel for our APIs before writing code. The following steps will make this process easier.
Get Our Postman Collection
If you've downloaded our Postman collection, you should be seeing our APIs on the left and the appropriate environment variables on the right.
Add Client Keys
The next step is to add your own client keys into the environment variables.
Create User
The next step is to create a user account and supply all of their KYC.
Once the user account is created, go to the dashboard to see the user there. If everything is right, you will see the user go to
Send and Receive Permissions on the dashboard.
If you are curious about the user profile and want to see more details, just click on the user, the dashboard will show you all the information you just added to the user profile.
OAuth User
The next step will be to start performing actions on behalf of the user. To do that, you need to grab an OAuth token for the user.
To do that, usually, make a View User API call and grab the
refresh_token from the user profile. With our Postman collection, all of that is automated.
So the next step is to Create an OAuth Key. Currently, we will make an OAuth key with all the scopes. You can later learn how to customize scopes as well.
Same as before, we will automatically set the appropriate OAuth key for you.
Also, when you Sign in as a User on the dashboard, the same operation is happening behind the scenes.
You can Sign In by supplying the fingerprint you created the user account with:
Now, you can perform all the actions on behalf of the user from the dashboard, like how you can with the APIs.
Launch a Hub
Now if you'll go back to the dashboard, you will see the Deposit Node under the user profile.
Congratulations! 🎊 🎈 🎉 You've successfully created a deposit account for your user.
Enable Some Features
Now let's enable some features on this deposit account.
Enable External ACH
In this case, our user would like to enable ACH Credits and Debits via an External Account. So let's link an external ACH account:
Now let's verify the ACH account via Micro-deposits:
Now if you go to the dashboard, you will see an
ACH-US node linked under the user profile with Credit and Debit permissions.
Enable Direct Debit and Credit
Our user would also like to issue an account and routing number that they can give to their payroll provider and apps like Venmo and PayPal. So let's issue an account number for them:
Now if you go to the dashboard, Sign In as User, and click on the Deposit Account, you will see the account and routing numbers issued on the account:
Issue a Card
Our user would also like to issue a card so they can use this account for shopping and other expenses. So let's issue one for them:
Now if you go to the dashboard, Sign In as User, and click on the Deposit Account, you will see the card number issued on the account:
Now your user has a fully functioning Deposit Hub!! 😀
Subscribe to Updates
In our next step, let's use Webhook Site to test subscribing to updates as they occur in the system.
Let's get our Webhook URL:
Now let's create a Subscription:
You will be able to see this subscription created on the dashboard as well:
To test this, let's issue another account number for our user:
Since we had subscribed to
SUBNETS|POST updates, you will see a webhook set to your Webhook Site link:
You can view the logs on the dashboard as well:
Create Transactions
As our final step of this tutorial, let's fund our user's deposit account so that they can go out and spend:
If you'll go to the dashboard, you will see the transaction created:
In a few minutes, the transaction will move to settled:
Now our user has funds in their account to spend:
Next Steps
As next steps, we would recommend:
1. Taking our language SDKs for a spin: Python | JavaScript | Ruby | PHP | Go.
Last modified 12d ago