Instant Pay (Early Access)

Intro

Zeal's Instant Pay product allows workers to get faster access to their funds. Once a worker completes instant pay enrollment, an instant pay Wallet is created for them and instant pay is now available as a disbursement method for an employee check or contractor payment (e.g. net pay is sent to the Wallet). A worker can currently see their instant pay wallet balance, transaction history, and transfer funds out of the wallet to their debit card through the whitelabeled mobile app. Zeal also offers API endpoints to manage wallets and transfers.

Note: This product is in Early Access. Please reach out to the Zeal team to get access to this Product.

In this guide

How to include the instant pay enrollment screen in worker onboarding
How to set instant pay as a disbursement method on an employee check or contractor payment
How workers can access instant pay wallet details
How to access instant information in the Zeal API

Instant Pay Enrollment Screen

Every worker must complete instant pay enrollment. To include the instant pay enrollment page in worker onboarding, you can set instant_pay to true when generating the Contractor Onboarding Link or when generating the Employee Onboarding Link. You can also retrieve just the instant pay enrollment screen for employees or contractors at any time, even after a worker is onboarded.

A worker must agree and consent to agreements on the Instant Pay Enrollment page. Once the employee object or contractor object will now show instant_pay_enabled = true.

Recommendation: You can embed the onboarding or individual enrollment link as an iframe or webview in your existing app.

Instant Pay in Mobile App

Workers can access their instant pay details by logging into their worker dashboard in the mobile app and navigating to the "Earnings" > "Instant pay" screen. On this page, workers can:

View the instant pay balance
See transaction history
Transfer funds instantly to their debit card
Add a debit card to their profile

Instant Pay API

You can use the API to manage a worker's instant pay program. These endpoints help you create a UI for your own instant pay program:

Instant Pay Disbursement Method

If you wish to have a worker's net pay be sent to their instant pay wallet, you can set disbursement_method = instant_pay when creating an employee check or contractor payment. If the disbursement method is set to instant_pay, the net pay amount will be available in the wallet when payroll is processed (e.g. the balance on the wallet will increase by the net pay amount and a new credit transaction will be shown to the worker).

You will receive an error if you try to use disbursement_method = instant_pay on a worker that does not have instant_pay_enabled = true.

Recap

Workers must complete the instant pay enrollment page which can be included in worker onboarding through UI or API
Workers can access the Instant Pay page in the mobile app
Instant Pay API endpoints are available to manage a worker's wallet