Vendor Introduction
Vendors in the TCash ecosystem are companies that provide services to their registered users. TCash services are provided to vendors through a large retail network processing deposits and withdrawals in cash.
This guide will explain how to integrate the vendor's system with TCash for accepting deposits from users and optionally allowing users to withdraw funds from their accounts.
Overview
Deposit
To make a deposit, the TCash system sends a user identifier and the amount to deposit to the vendor system.
Vendor's system needs to validate the request and be able to execute the deposit by increasing the users' balance.
The user identifier is a unique identifier of the user in the vendor's system. It can be an Account number, a username, an email address, a phone number or any other identifier that the Vendor wishes to use.
There are multiple ways in which the TCash system determines the identifier of the user.
The basic integration requires the user to provide their identifier at the time of deposit
However, we recommend automating user identification. We support redirecting the user's browser to a Vendor provided url, so the vendor system can identify the user and redirect them back to our page with the identifier included. This method allows the user to not have to remember or enter any id.
More information on this can be found on the dedicated identifier page.
Withdrawal
When a user wishes to withdraw funds from their account, the procedure works oppositely. Vendor's application should facilitate the withdrawal process by providing TCash to the user as a payout method.
All checks for the user's eligibility for withdrawal are done by the vendor before contacting TCash. This includes any internal checks. Once the withdrawal has been finally approved, the vendor calls the TCash API to execute the withdrawal.
As with the deposit, we provide a way for the user to remain anonymous to TCash and the cashier at the retail location.