# DailyPay Public Rest API Embed DailyPay and On Demand Pay features into your application. Version: 3.0.0-beta01 License: MIT ## Servers DailyPay REST API server ``` https://api.{environment}.com ``` Variables: - `environment` Default: "dailypay" Enum: "dailypay", "dailypayuat" ## Security ### oauth_client_credentials_token Type: oauth2 ### oauth_user_token Type: oauth2 ## Download OpenAPI description [DailyPay Public Rest API](https://developer.dailypay.com/_spec/developer-resources/documentation/index.yaml) ## 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. ### Get an Account object - [GET /rest/accounts/{account_id}](https://developer.dailypay.com/developer-resources/documentation/accounts/readaccount.md): Returns details about an account. This object represents a person's bank accounts, debit and pay cards, and earnings balance accounts. ### Get a list of Account objects - [GET /rest/accounts](https://developer.dailypay.com/developer-resources/documentation/accounts/listaccounts.md): 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. ### Create an Account object - [POST /rest/accounts](https://developer.dailypay.com/developer-resources/documentation/accounts/createaccount.md): Create an account object to store a person's bank or card information as a destination for funds. ## Health The _health_ endpoint provides a simple health check for the API. **Functionality:** Check the status of the API to ensure it is functioning correctly. ### Verify the status of the API - [GET /rest/health](https://developer.dailypay.com/developer-resources/documentation/health/gethealth.md): Returns a 200 status code if the API is up and running. ## 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. ### Get a job object - [GET /rest/jobs/{job_id}](https://developer.dailypay.com/developer-resources/documentation/jobs/readjob.md): Returns details about a person's employment. ### Update paycheck settings or deactivate a job - [PATCH /rest/jobs/{job_id}](https://developer.dailypay.com/developer-resources/documentation/jobs/updatejob.md): Update this job to set where pay should be deposited for paychecks related to this job, or deactivate on-demand pay for this job. Returns the job object if the update succeeded. Returns an error if update parameters are invalid. ### Get a list of job objects - [GET /rest/jobs](https://developer.dailypay.com/developer-resources/documentation/jobs/listjobs.md): Returns a collection of job objects. This object represents a person's employment details. See Filtering Jobs for a description of filterable fields. ## 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. ### Get an organization - [GET /rest/organizations/{organization_id}](https://developer.dailypay.com/developer-resources/documentation/organizations/readorganization.md): Lookup organization by ID for a detailed view of single organization. ### List organizations - [GET /rest/organizations](https://developer.dailypay.com/developer-resources/documentation/organizations/listorganizations.md): Get organizations with an optional filter ## 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. ### Get a Paycheck object - [GET /rest/paychecks/{paycheck_id}](https://developer.dailypay.com/developer-resources/documentation/paychecks/readpaycheck.md): Returns details about a paycheck object. ### Get a list of paycheck objects - [GET /rest/paychecks](https://developer.dailypay.com/developer-resources/documentation/paychecks/listpaychecks.md): Returns a collection of paycheck objects. This object details a person's pay and pay period. See Filtering Paychecks for a description of filterable fields. ## People The _people_ endpoint allows you to see information related to who owns resources such as jobs and accounts. **Functionality:** Retrieve limited details about a person, including their name, global status, and state of residence. ### Get a person object - [GET /rest/people/{person_id}](https://developer.dailypay.com/developer-resources/documentation/people/readperson.md): Returns details about a person. ### Update a person - [PATCH /rest/people/{person_id}](https://developer.dailypay.com/developer-resources/documentation/people/updateperson.md): Update a person object. ## 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 ### Get a transfer object - [GET /rest/transfers/{transfer_id}](https://developer.dailypay.com/developer-resources/documentation/transfers/readtransfer.md): Returns details about a transfer of money from one account to another. Created when a person takes an advance against a future paycheck, or on a daily basis when available balance is updated based on current employment. ### Get a list of transfers - [GET /rest/transfers](https://developer.dailypay.com/developer-resources/documentation/transfers/listtransfers.md): Returns a list of transfer objects. See Filtering Transfers for a description of filterable fields. ### Request a transfer - [POST /rest/transfers](https://developer.dailypay.com/developer-resources/documentation/transfers/createtransfer.md): Request transfer of funds from an account to a personal or account. ## Card Tokenization Securely tokenize personal cards for use in the accounts API. ### Obtain a card token - [POST /cards/generic](https://developer.dailypay.com/developer-resources/documentation/card-tokenization/creategenericcardtoken.md): Obtain a PCI DSS Compliant card token. This token must be used in order to add a card to a user’s DailyPay account.