DailyPay 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 REST API.

In general, DailyPay APIs have two environments per API and follow the naming structure of dailypay.com for the Production environment and dailypayuat.com or uat.dailypay.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 \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --data-urlencode "filter[external_identifiers.primary_identifier]=040919553433" \
  'https://api.dailypayuat.com/rest/jobs' 

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

Idempotency ensures that duplicate requests are processed only once, preventing unintended side effects such as double charges or duplicate resource creation. The API will return the same response for any number of identical requests that use the same idempotency key.

When making requests to endpoints that support idempotency, include the Idempotency-Key header with a unique value for each logical operation.

How it works:

• Idempotency keys are retained for 24 hours per key. After 24 hours the key may be reused for a new payload.
• It is always safe to retry the same request with the same key.
• The response payload will be identical for duplicate requests, including error responses.
  • The error response will be the same even if the error is the result of a failed precondition (e.g., insufficient funds) that has since been satisfied.
• To help prevent accidental key recycling, if the request payload differs in any way (e.g., different parameters or body content), a new idempotency key must be used.
• If the request payload has invalid syntax such that it can not be processed or understood, idempotency will not apply.
• If multiple simultaneous requests use the same idempotency key, one may succeed and others may receive an HTTP 409 Conflict error. This only applies to requests being processed at the exact same time.

• 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.