Embedded Pay
Everything you need to know about how to seamlessly manage your Pay programme with the Onsi On-demand Pay API. Below you’ll find documentation on how to integrate Pay into your application.
Introduction
Embedded pay allows you to embed the Onsi pay experience into your application, allowing you to perform withdrawals on behalf of your members.
Embedded pay is an additional feature that can be enabled on your account. Please contact us to enable this feature.
Withdrawal Journey
The withdrawal process for a member is as follows:
Allow your members to start withdrawal
Show a member their available balance from the Get Member Balance endpoint, present them the option to input the amount they would like to withdraw.
Create a new Withdrawal Intent with Onsi API
Create a withdrawal intent using the Create Withdrawal Intent endpoint, this returns any associated fees which will be deducted (if applicable), make sure to present this information to the user so they may confirm.
Confirm the withdrawal if member is happy
If the member confirms the withdrawal, call the Confirm Withdrawal endpoint to complete the withdrawal.
After the withdrawal is confirmed, the member will receive the net amount of the withdrawal, and the fees will be deducted from the member’s account.
Pay Management
Your pay programme can be managed through the Onsi API.
Pay cycles will be created for your by Onsi during your onboarding process. From then on all you need to do is let us know who you would like to pay and how much, and we will take care of the rest.
When pay details are uploaded they will be associated with the current cycle that is open.
If a member is included in you pay upload that has yet to be invited by you to our platform they will not be included in the pay details, we will respond with a 400 and list the ineligible members.
To make a member eligible you will need to first invite them to the platform. Then you can upload their pay details and they will be included in the pay cycle.