This API reference is your guide to understanding the DailyPay Public REST API and how to embed DailyPay functionality and Earned Wage Access into your application.
For an overview of the DailyPay Public REST API functionality, see the DailyPay Public REST API Introduction.
The DailyPay Public REST API uses OAuth 2.0 for authentication. The DailyPay Public REST API OAuth Overview provides a detailed explanation of the OAuth 2.0 Authorization Code Grant and Client Credentials Flow.
Code Samples are provided for each endpoint in the DailyPay Public REST API Reference. The Try It feature allows you to test the API endpoints directly from the developer portal and is only available in the UAT environment.
Check back soon for DailyPay Public REST API Changelogs for a list of changes, features, and updates to the DailyPay Public REST API.
Make sure you subscribe to or keep an eye on the DailyPay Status Page for the current status of the DailyPay Public REST API.
In general, DailyPay APIs have two environments per API and follow the naming structure of api.dailypay.com
for the Production environment and api.dailypayuat.com
for the UAT environment.
API Name | Production URL | UAT URL |
---|---|---|
DailyPay Public REST API | https://api.dailypay.com |
https://api.dailypayuat.com |
Data Exchange API | https://api.dailypay.com |
https://api.dailypayuat.com |
Payments API | https://payments-api.dailypay.com |
https://payments-api.dailypayuat.com |
Environment | Purpose | Access | Data |
---|---|---|---|
Production | Live environment for processing production API Traffic | Restricted access for authorized clients and users only | Real production data exchanges including money movement |
UAT | Staging environment for developers to test new features, updates, and changes | Less restricted access for both developers and testers | Test data and exchanges without money movement |
Function | UAT | Production |
---|---|---|
Testing user data without PII | ✓ | |
Ability to mock transfer of funds | ✓ | |
Ability to integrate with custom code | ✓ | ✓ |
Access to real-world transactions like ACH Deposits | ✓ | |
Live customer data | ✓ | |
Live transactions moving real funds | ✓ |
Each API at DailyPay adheres to semver standards for versioning, represented as MAJOR.MINOR.PATCH
:
MAJOR
version is incremented for breaking changes.MINOR
version is incremented for backwards compatible changes.PATCH
version is incremented for backwards compatible bug fixes.DailyPay will issue a new major API version when a breaking change occurs.
To avoid breaking your code, developers are responsible for updating their API calls to interact with new versions of the DailyPay APIs.
Communication about API changes will be in the changelogs for the APIs or available from your DailyPay representatives.
Your API version controls the API behavior, properties in responses, available parameters in requests, and so on.
If you want to use API version v3
of the DailyPay Public REST API, specify the URL https://api.dailypay.com/rest
or https://api.dailypayuat.com/rest
.