logo

Extend API Introduction

Core Functionality of the Extend API

The Extend API provides a simple set of endpoints to provide Earned Wage Access to your application's users. You do not have to use all the functionality of the Extend API to realize the benefits of Earned Wage Access.

  • These documents help explain the concepts of the Extend API and the types of functionality that can be embedded into your application.
  • For instructions on embedding DailyPay Earned Wage Access into your application see the Getting Started portion of the API Reference Section.

Developers can search for any organization they are authorized to view. Organizations can be searched by name or other identifying information, allowing developers to locate the correct organization(s) for their application.

  • See the Generic Filtering documentation for more information on the query parameters that can be used to filter organizations.
  • See the Organization Endpoint for more information on the fields that are returned for each organization.
Scenario Examples

Why consider leveraging the Organization Search endpoint?

  • Empower User Eligibility Confirmation As a developer, you can utilize the organization search feature to let users confirm their employers' eligibility for Earned Wage Access.

  • Efficient Access Visibility You can benefit from the ability to view a consolidated list of organizations to which they have access, helping you determine which organizations are eligible for Earned Wage Access.

  • Streamlined Information Retrieval By calling the organization's endpoint with an organization ID, you can get the name of a specific organization, offering a convenient means of accessing its information.

Example User-case

You may wish to add an organization dropdown feature for a user to select their organization when signing up for earned wage access. The organizations endpoint can provide a list of eligible organizations that the user can select from.

Once an organization has been located, developers can see the list of eligible employee accounts at that organization.

  • Authentication Overview - A user must authorize their identity and give consent so you can have access to request the user's paychecks, take earned wage access transfers on behalf of the user, add bank accounts and debit cards to their account, or check their available balance among other features.

User Capabilities

Once a user has given consent for you to access their information, as the developer, you will be able to make use of the following user resources.

User Account

User accounts are the core of the Extend API, allowing employees to view their paychecks, take earned wage access transfers, view their available balance, and add bank accounts and debit cards to their accounts among other features.

Scenario Examples
  1. As a developer, you want to see if a user is eligible to use the Extend API.
  2. As a developer, you want to know if the user can take earned wage access transfers.
  3. The employee wants to see the details of their account, including their name, email address, and phone number.
  4. The employee wants to see their available balance, which is the amount of money they have earned and are eligible to transfer ahead of payday.

Paychecks

Paychecks are a critical component of the Extend API, allowing employees to receive direct deposit to an account, minus any earned wage access transfers that were taken ahead of payday. API users can view paycheck data, including:

  • total_debited: the amount the user has advanced during the paycheck, inclusive of fees.
  • withholdings: gross pay (provider paid) - This includes various deductions like taxes, garnishments, and other payments made on your behalf by the provider.
  • earnings: the user's gross pay of the pay period

See the Paychecks Endpoint for more information on the fields that are returned for each paycheck.

Scenario Examples
  1. The employee wants to see the details of one or more paychecks, including the paycheck amount, and how much they are eligible to transfer ahead of payday.
  2. If an employee takes an early transfer, they want to know the next paycheck's pay date to anticipate when the remaining amount will be deposited into their bank account

Transfers

Transfers are a key aspect of embedded DailyPay functionality, when organizations participate in Earned Wage Access, it allows their employees to access their earned wages ahead of payday. Employees can initiate and track transfers, including the transferred amount and associated fees.

  • See the Post Transfer reference for the full details of creating a transfer
  • See the Get Transfer reference for the full details of a previous transfer.
Scenario Examples
  1. The employee wants to initiate an earned wage access transfer to their debit card ahead of payday.
  2. The employee wants to see the details of one or more transfers, including the amount of the transfer, the number and amount of fees charged, and the amount of the transfer that was transferred to the employee's bank account or debit card ahead of payday.

Bank Account and Debit Card Management

Organizations, partners, or users can add or edit debit cards and bank accounts to their DailyPay accounts using the PCIE Compliant Payments Endpoint.

  • For Debit Cards, the Payments Documentation makes it easy to tokenize debit cards and add them to a user's account so they can take earned wage access transfers ahead of payday.

  • Transfer Account Endpoint - You may also check to see the details of an account that already exists and is attached to a user.

Scenario Examples
  1. As a developer, you want to locate a user's bank account or debit card information if it already exists.
  2. The employee wants to add a bank account or debit card to their DailyPay account.
  3. The employee wants to edit a bank account or debit card on their DailyPay account.
  4. The employee wants to differentiate between a transfer account and a remainder account (i.e. where to send early transfers and the paycheck remainder.)
➔ Next to Getting Started