Embed DailyPay and On Demand Pay features into your application.
DailyPay Public Rest API (3.0.0-beta01)
Download OpenAPI description
Overview
URL
License
MIT
Languages
Servers
Mock server
https://developer.dailypay.com/_mock/developer-resources/documentation/
DailyPay REST API server
https://api.{environment}.com/
API Status
Please subscribe to the DailyPay Status Page for the current status of the DailyPay Public REST API.
Environments
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 | ✓ |
Filtering
Efficiently retrieve DailyPay REST API resources with filtering queries by specifying query parameters in the request URL. This guide outlines how to build your queries.
The request URL for a filtered query is structured as follows:
https://api.dailypay.com/{endpoint}?filter[{field}]={value}
Each filter is a standard URL query parameter key-value pair. Filter parameters follow the jsonapi specification of a query parameter family, where the parameter key is the base name filter followed by a square-bracketed ([]) field name.
- The
{endpoint}is the resource you want to filter, such as organizations, transfers, or paychecks. - A
{field}is the attribute of a resource you want to filter by, such as a person's employee ID or a transfer's status. - A
{value}is any value that could be a valid payload for the attribute, such as "DailyPay" for an organization name, or "PROCESSING" for a transfer status.
The symbols used in DailyPay's filter strings MUST be urlencoded.
For example, a curl would look like:
curl \
--get 'https://api.dailypayuat.com/rest/jobs' \
--header "Authorization: Bearer ${ACCESS_TOKEN}" \
--data-urlencode "filter[external_identifiers.primary_identifier]=040919553433" \
--includeWhen using one of our published SDKs, you do not have to transform or urlencode filter keys.
Filter for a paycheck with the status "IN_TRANSIT".
GET https://api.dailypay.com/paychecks?filter[status]=IN_TRANSITUse multiple query parameters across different fields filter[{field}]={value} at the same time to fine tune the response. Each result will match all filters.
GET https://api.dailypay.com/paychecks?filter[job.id]=12345&filter[status]=PROCESSINGVersioning
Each API at DailyPay adheres to semver standards for versioning, represented as
MAJOR.MINOR.PATCH:- The
MAJORversion is incremented for breaking changes. - The
MINORversion is incremented for backwards compatible changes. - The
PATCHversion is incremented for backwards compatible bug fixes.
- The
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.
- New resources
- New optional query parameters
- New optional body properties on PATCH, POST, PUT
- New properties on existing API responses
- Property order changes on existing API responses
- Changes to the content, length, or format of error messages and other human-readable strings
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.
Accounts
The accounts endpoint provides comprehensive information about money accounts. You can retrieve account details, including the account's unique ID, a link to the account holder, type, subtype, verification status, balance details, transfer capabilities, and user-specific information such as names, routing numbers, and partial account numbers.
Functionality: Access detailed user account information, verify account balances, view transfer capabilities, and access user-specific details associated with each account.
Operations
- Mock server
https://developer.dailypay.com/_mock/developer-resources/documentation/rest/accounts/{account_id}
- DailyPay REST API server
https://api.dailypay.com/rest/accounts/{account_id}
- JavaScript
- Go
- C#
- Java
- Python
- Ruby
- cURL
import { SDK } from "@dailypay/dailypay";
const sdk = new SDK({
version: 3,
security: {
oauthClientCredentialsToken: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
tokenURL: "<YOUR_TOKEN_URL_HERE>",
},
},
});
async function run() {
const result = await sdk.accounts.read({
accountId: "2bc7d781-3247-46f6-b60f-4090d214936a",
});
console.log(result);
}
run();Returns the account object.
The unique identifier of the Account.
Example: "2bc7d781-3247-46f6-b60f-4090d214936a"
The type of the resource. Always accounts.
Example: "accounts"
Value "accounts"
data.attributesCard (object) or Earnings Balance (read only) (object) or Depository (object)(AccountAttributes)required
One of:
An account with type CARD and subtype DAILYPAY or DEBIT.
A code that indicates the status of an account that is a destination for funds.
Enum"VERIFICATION_PENDING""VERIFICATION_FAILED""VERIFIED"
Example: "VERIFIED"
The amount of funds available to be withdrawn from the account.
For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows,
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Example: 12000
The total amount of funds settled in the account.
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Special note for earnings_balance-type accounts: During a typical pay period, if a user transfers no money from an earnings_balance-type account to a personal account, the current balance will generally be 0, because transfers from earnings to this account will be PENDING until the paycheck related to those earnings is processed. Pending inflows are included in the available balance, not the current balance.
If a user transfers money from an earnings_balance-type account to a personal account, the current balance will be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the default_paycheck_destination set for the associated Job.
If DailyPay is unable to zero out the balance during paycheck processing, the current balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0.
Example: 50000
data.attributes.capabilities.transfer_destinationArray of objects(TransferDestinationCapability)>= 0 itemsrequired
List of the timing and associate fees available when crediting this account as a transfer destination.
Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer.
Example: [{"schedule":"WITHIN_THIRTY_MINUTES","fee":300,"currency":"USD"},{"schedule":"NEXT_BUSINESS_DAY","fee":0,"currency":"USD"}]
The expected time for the transfer to be completed.
Enum"WITHIN_THIRTY_MINUTES""NEXT_BUSINESS_DAY"
Example: "WITHIN_THIRTY_MINUTES"
A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { amount: 299, currency: 'USD' } resolves to $2.99.
If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.
Example: 0
The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay).
Value "CARD"
The subtype of the account. Additional subtypes may be added over time
Enum"DEBIT""DAILYPAY"
Example: "DEBIT"
The banking details of the account and account holder.
Last four digits of the card number.
Example: "0003"
The first name of the account holder.
Example: "Edith"
The last name of the account holder.
Example: "Clarke"
The month of the expiration date for the card.
Example: "02"
Response
application/vnd.api+json
{ "data": { "id": "2bc7d781-3247-46f6-b60f-4090d214936a", "type": "accounts", "attributes": { "verification_status": "VERIFIED", "balances": { … }, "capabilities": { … }, "name": "Debit Card", "account_type": "CARD", "subtype": "DEBIT", "details": { … } }, "links": { "self": "https://api.dailypay.com/rest/accounts/2bc7d781-3247-46f6-b60f-4090d214936a" }, "relationships": { "person": { … } } } }
Request
Returns a list of account objects. An account object represents a person's bank accounts, debit and pay cards, and earnings balance accounts. See Filtering Accounts for a description of filterable fields.
Security
oauth_client_credentials_token or oauth_user_token
Query
Limit the results to documents matching the specified account type.
Enum"EARNINGS_BALANCE""DEPOSITORY""CARD"
Example: filter[account_type]=EARNINGS_BALANCE
- Mock server
https://developer.dailypay.com/_mock/developer-resources/documentation/rest/accounts
- DailyPay REST API server
https://api.dailypay.com/rest/accounts
- JavaScript
- Go
- C#
- Java
- Python
- Ruby
- cURL
import { SDK } from "@dailypay/dailypay";
const sdk = new SDK({
version: 3,
security: {
oauthClientCredentialsToken: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
tokenURL: "<YOUR_TOKEN_URL_HERE>",
},
},
});
async function run() {
const result = await sdk.accounts.list({
filterAccountType: "EARNINGS_BALANCE",
});
console.log(result);
}
run();Returns the account object.
The unique identifier of the Account.
Example: "2bc7d781-3247-46f6-b60f-4090d214936a"
The type of the resource. Always accounts.
Example: "accounts"
Value "accounts"
data[].attributesCard (object) or Earnings Balance (read only) (object) or Depository (object)(AccountAttributes)required
One of:
An account with type CARD and subtype DAILYPAY or DEBIT.
A code that indicates the status of an account that is a destination for funds.
Enum"VERIFICATION_PENDING""VERIFICATION_FAILED""VERIFIED"
Example: "VERIFIED"
The amount of funds available to be withdrawn from the account.
For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows,
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Example: 12000
The total amount of funds settled in the account.
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Special note for earnings_balance-type accounts: During a typical pay period, if a user transfers no money from an earnings_balance-type account to a personal account, the current balance will generally be 0, because transfers from earnings to this account will be PENDING until the paycheck related to those earnings is processed. Pending inflows are included in the available balance, not the current balance.
If a user transfers money from an earnings_balance-type account to a personal account, the current balance will be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the default_paycheck_destination set for the associated Job.
If DailyPay is unable to zero out the balance during paycheck processing, the current balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0.
Example: 50000
data[].attributes.capabilities.transfer_destinationArray of objects(TransferDestinationCapability)>= 0 itemsrequired
List of the timing and associate fees available when crediting this account as a transfer destination.
Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer.
Example: [{"schedule":"WITHIN_THIRTY_MINUTES","fee":300,"currency":"USD"},{"schedule":"NEXT_BUSINESS_DAY","fee":0,"currency":"USD"}]
The expected time for the transfer to be completed.
Enum"WITHIN_THIRTY_MINUTES""NEXT_BUSINESS_DAY"
Example: "WITHIN_THIRTY_MINUTES"
A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { amount: 299, currency: 'USD' } resolves to $2.99.
If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.
Example: 0
The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay).
Value "CARD"
The subtype of the account. Additional subtypes may be added over time
Enum"DEBIT""DAILYPAY"
Example: "DEBIT"
The banking details of the account and account holder.
Last four digits of the card number.
Example: "0003"
The first name of the account holder.
Example: "Edith"
The last name of the account holder.
Example: "Clarke"
The month of the expiration date for the card.
Example: "02"
Response
application/vnd.api+json
{ "data": [ { "id": "2bc7d781-3247-46f6-b60f-4090d214936a", "type": "accounts", "attributes": { … }, "links": { … }, "relationships": { … } } ] }
Headers
Bodyapplication/vnd.api+jsonrequiredThe version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.
Default 3
The type of the resource. Always accounts.
Example: "accounts"
Value "accounts"
data.attributesCard (object) or Earnings Balance (read only) (object) or Depository (object)(AccountAttributes)required
One of:
An account with type CARD and subtype DAILYPAY or DEBIT.
The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay).
Value "CARD"
The subtype of the account. Additional subtypes may be added over time
Enum"DEBIT""DAILYPAY"
Example: "DEBIT"
The banking details of the account and account holder.
A tokenized string replacement for the card data.
Example: "HX46TY794RG"
The first name of the account holder.
Example: "Edith"
The last name of the account holder.
Example: "Clarke"
The month of the expiration date for the card.
Example: "02"
The year of the expiration date for the card.
Example: "2025"
The first line of the address for the card.
Example: "123 Kebly Street"
The second line of the address for the card.
Example: "Apt #12"
The city of the address for the card.
Example: "Fort Lee"
The two-letter abbreviation of the state in the address for the card.
Example: "NJ"
The zip code of the address for the card.
Example: "72374"
- Mock server
https://developer.dailypay.com/_mock/developer-resources/documentation/rest/accounts
- DailyPay REST API server
https://api.dailypay.com/rest/accounts
- JavaScript
- Go
- C#
- Java
- Python
- Ruby
- cURL
import { SDK } from "@dailypay/dailypay";
const sdk = new SDK({
version: 3,
security: {
oauthClientCredentialsToken: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
tokenURL: "<YOUR_TOKEN_URL_HERE>",
},
},
});
async function run() {
const result = await sdk.accounts.create({
data: {
type: "accounts",
attributes: {
name: "Acme Bank Checking Account",
accountType: "DEPOSITORY",
subtype: "CHECKING",
depositoryAccountDetails: {
firstName: "Edith",
lastName: "Clarke",
routingNumber: "XXXXX2021",
accountNumber: "XXXXXX4321",
},
},
relationships: {
person: {
data: {
type: "people",
id: "3fa8f641-5717-4562-b3fc-2c963f66afa6",
},
},
},
},
});
console.log(result);
}
run();Returns the account object.
The unique identifier of the Account.
Example: "2bc7d781-3247-46f6-b60f-4090d214936a"
The type of the resource. Always accounts.
Example: "accounts"
Value "accounts"
data.attributesCard (object) or Earnings Balance (read only) (object) or Depository (object)(AccountAttributes)required
One of:
An account with type CARD and subtype DAILYPAY or DEBIT.
A code that indicates the status of an account that is a destination for funds.
Enum"VERIFICATION_PENDING""VERIFICATION_FAILED""VERIFIED"
Example: "VERIFIED"
The amount of funds available to be withdrawn from the account.
For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows,
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Example: 12000
The total amount of funds settled in the account.
This value is in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
Special note for earnings_balance-type accounts: During a typical pay period, if a user transfers no money from an earnings_balance-type account to a personal account, the current balance will generally be 0, because transfers from earnings to this account will be PENDING until the paycheck related to those earnings is processed. Pending inflows are included in the available balance, not the current balance.
If a user transfers money from an earnings_balance-type account to a personal account, the current balance will be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the default_paycheck_destination set for the associated Job.
If DailyPay is unable to zero out the balance during paycheck processing, the current balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0.
Example: 50000
data.attributes.capabilities.transfer_destinationArray of objects(TransferDestinationCapability)>= 0 itemsrequired
List of the timing and associate fees available when crediting this account as a transfer destination.
Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer.
Example: [{"schedule":"WITHIN_THIRTY_MINUTES","fee":300,"currency":"USD"},{"schedule":"NEXT_BUSINESS_DAY","fee":0,"currency":"USD"}]
The expected time for the transfer to be completed.
Enum"WITHIN_THIRTY_MINUTES""NEXT_BUSINESS_DAY"
Example: "WITHIN_THIRTY_MINUTES"
A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { amount: 299, currency: 'USD' } resolves to $2.99.
If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.
Example: 0
The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay).
Value "CARD"
The subtype of the account. Additional subtypes may be added over time
Enum"DEBIT""DAILYPAY"
Example: "DEBIT"
The banking details of the account and account holder.
Last four digits of the card number.
Example: "0003"
The first name of the account holder.
Example: "Edith"
The last name of the account holder.
Example: "Clarke"
The month of the expiration date for the card.
Example: "02"
Response
application/vnd.api+json
{ "data": { "id": "2bc7d781-3247-46f6-b60f-4090d214936a", "type": "accounts", "attributes": { "verification_status": "VERIFIED", "balances": { … }, "capabilities": { … }, "name": "Debit Card", "account_type": "CARD", "subtype": "DEBIT", "details": { … } }, "links": { "self": "https://api.dailypay.com/rest/accounts/2bc7d781-3247-46f6-b60f-4090d214936a" }, "relationships": { "person": { … } } } }
Jobs
The jobs endpoint provides access to comprehensive information about a person's employment. It enables you to retrieve details about individual jobs, including information about the organization they work for, status, wage rate, job title, location, paycheck settings, and related links to associated accounts.
Operations
Organizations
The organizations endpoint provides details about a business entity, such as an employer, or a group of people, such as a division.
The response includes the organization name and ID which can be used to make subsequent endpoint calls related to the organization and its employees.
Operations
Paychecks
The paychecks endpoint provides detailed information about paychecks. You can retrieve individual paycheck details, including the person and job associated with the paycheck, its status, pay period, expected deposit date, total debited amount, withholdings, earnings, and currency.
Functionality: Retrieve specific paycheck details, including payee and job information, and monitor the status and financial details of each paycheck.
Operations
Transfers
The transfers endpoint allows you to initiate and track money movement. You can access transfer details, including the transfer's unique ID, amount, currency, status, schedule, submission and resolution times, fees, and related links to the involved parties.
Functionality Retrieve transfer information, monitor transfer statuses, view transfer schedules, and access relevant links for the source, destination, and origin of the transfer.
Important - Account origin: a user initiated movement of money from one account to another - Paycheck origin: an automatic (system-generated) movement of money as part of payroll
Operations