Imburse platform lets you collect money or payout or rewards. But, you might be eager to see how it works. This Getting Started guide is designed to walk you through the quickest and simplest steps that you can follow to see the core functionality of the platform.
If you are just starting your journey with the Imburse platform and are eager to learn what Imburse platform can do for you, this guide is for you. This guide is also for you if you want to refresh you knowledge on the basic functionality of the Imburse platform.User Guide for in-depth information on the features available in the Imburse platform.
Before you start using this guide there are a few prerequisites that you will need to meet. Some of the following prerequisites, as "Setup an Account" and "Setup a Tenant" might only be required once. If you have already completed the following setup, you can directly jump to the 4-Steps that Demonstrate the Imburse Plaform.Concepts page for a list of all the terminologies used in the Imburse platform. Account. You will have to setup your Account to obtain Account API Key.
At Imburse, we believe in experimenting with the product, in addition to reading guides about it. We invite you to perform the following 4-steps so that you can feel even more confident about our capabilities.
- Authenticate your Identity
- Create an Order and Instruction
- Load Checkout Component
- Get Transaction Status
Just as you would require a password to access your email address or a key to unlock the door at your house, Imburse also requires a key from you before you can access any Imburse features. Imburse uses this key to prevent anyone who doesn't have access to your tenant from accessing your information. Imburse uses industry-standard HMAC token to generate the key (Access Token) that will be used to authenticate your requests.
- Create and Obtain your Tenant API Key.
- Generate the HMAC Token
- Create an Access Token by sending the HMAC Token to our
- Use the Access Token in the
Authorizationheader of your following API requests
- Get the
schemeIdfrom one of the schemes you created while setting up the Tenant.
- Follow the API Reference documentation on Create Instruction to create the request body for Instruction(s) using the
- Set the
Debitfor collection and
Creditfor rewards payout.
- To collect recurrently or schedule future payments, set the value of the
settledByDateproperty to the date when Imburse should process the payment.
- Follow the API Reference documentation on Create Order to create the request body for the Order that will group the Instruction(s) you've created.
- Use the
orderRefvalue you had set while creating Orders and
instructionRefvalue you had set while creating Instructions to create request body for generating Session Token.
- Load the Checkout Component using the Session Token and present it to your customers.
Once your customer submits the Financial Instrument and the Payment Service Provider processes the submission, you will be curious to know whether the transaction was successful. Imburse provides two different methods to get a report on the status of your transaction.