Getting Started

This guide will walk you through the steps needed to pay any employee or contractor wallet via APIs.

Pre-Requisites and Usage

Before you can start using the Wallets product, make sure you have the following:

Active Business Account: Your business must be registered and active on Cadana.
API Key: You need an organization API key to authenticate your API requests. Please refer to our API Key and Authentication Guide for details on how to obtain and use your API key.

Step 1: Creating a person

Every wallet is tied to an employee or contractor record in the business HR directory. The first step is to onboard the person.

Endpoint: Create Person API Reference

Step 2: Creating a user

Next, you’ll create a user account for that person. This automatically creates the underlying wallet that any payroll can be deposited into. By default, a local currency wallet in the compensation currency is created (e.g., if the contractor's pay is in USD, a USD wallet will be available to them).

Endpoint: Create User API Reference

If you are using custom authentication, you can suppress the welcome email which contains the standard password setup instructions.

Step 3: Running payroll

Running payroll is a three-step process:

a) Select the worker type employee/contractor and create a payroll.

Endpoint: Create Payroll API Reference

b) Provide the compensation information for each person for that payroll run.

Endpoint: Save Payroll API Reference

c) Approve the payroll.

Endpoint: Approve Payroll API Reference

If the business does not have sufficient funds, the payroll will move to an awaiting_funds state. If a bank account is connected, an ACH debit will be automatically initiated and the payroll will be processed once the funds are available. If the scheduled date is in the future, the payroll will get processed on the scheduled day.

Next Steps

With these steps, you should have successfully created and paid workers into their wallets. Check out the full API documentation for the rest of the functionality Full API Reference .