Everee Visa® Pay Card Signup

This guide is for developers integrating the Everee Visa® Pay Card into their apps. The Pay Card is a debit card that can be automatically issued to workers as part of their onboarding process so they can get paid instantly instead of waiting hours or days for an ACH transfer to complete.

It's issued both as a virtual card, so it can be used immediately after signup and integrated with digital wallets like Apple Pay and Google Pay, and as a physical debit card that can be used anywhere debit cards are accepted.

About the Pay Card

Everee manages the entire lifecycle of a Pay Card on your behalf, including initial signup, card mailing, transactions, funds transfers, and cardholder support.

When a worker signs up for the Pay Card, their default payment method is changed from Direct Deposit to the Pay Card. That means all future payments processed to that worker will be automatically transferred to their Pay Card rather than their bank account via ACH.

Payments transferred to workers' Pay Cards only take a few minutes to appear after they're approved in Everee. As soon as a payment appears on a Pay Card, the funds are available for the cardholder to make purchases and transfer to their personal bank account.

Embedding the Pay Card signup experience

You can embed the Pay Card signup experience into your own app, enabling your workers to get a Pay Card as part of the onboarding or account-setup workflow you already have. It's available as an Embed Component.

Everee turns the Pay Card feature on for your sandbox and live instances after reviewing and approving your use of it. It isn't enabled automatically. Talk to Everee Support if you want to start embedding Pay Card signup into your app.

Before you create a session

Both of these must be true before you create a PAY_CARD_SIGNUP Component Session for a worker:

RequirementDetails
The Pay Card is enabled for your companyEveree enables it after review and approval, separately for your sandbox and live instances.
The worker has an Everee login account with a passwordPay Card signup runs as the worker's own account. A worker gets a password when they complete the "Set up your account" steps of the ONBOARDING component. If you create that session with experienceOptions.accountSetupEnabled set to false, no login account or password is created, and Pay Card signup won't work for that worker. Leave accountSetupEnabled as true (the default) for any worker you plan to offer the Pay Card.

If you create a PAY_CARD_SIGNUP session for a worker who has no password, the request fails with a 400 and the message "Unable to locate a worker with the given ID." The worker ID is valid. The message refers to the missing account.

When a worker finishes signing up, Everee sends a worker.pay-card-signup-completed webhook event to your endpoints, so you don't need to poll to find out.

As with other Embed Components, you'll first create a Component Session using the Create Component Session endpoint. Set the experience field in the request to the value PAY_CARD_SIGNUP and the experienceVersion to V1_0.

You'll receive back a URL in the url field of the response. Display a web view of that URL to initiate the Component Session and display the Pay Card signup experience to the worker.

🚧

Native apps only, please

We only support embedding the Pay Card signup component in native apps, like those running on iOS and Android. We don't currently support embedding it in browsers.


Did this page help you?