DailyPay Public Rest API (3.0.0-beta01)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Please subscribe to 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.

DailyPay APIs and their respective environments

Key differences between the Production and UAT environments:

Functionality Differences

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.

URL Encoding

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" \
  --include

Examples

Exact Match

Filter for a paycheck with the status "IN_TRANSIT".

GET https://api.dailypay.com/paychecks?filter[status]=IN_TRANSIT

Multiple Filters: ALL

Use 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]=PROCESSING

• Each API at DailyPay adheres to semver standards for versioning, represented as MAJOR.MINOR.PATCH:

  • The MAJOR version is incremented for breaking changes.
  • The MINOR version is incremented for backwards compatible changes.
  • The 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.

DailyPay views the following items as backwards compatible non-breaking changes:

• 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

Selecting the API Version

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.