Payroll Resources (ordered by popularity)
The Payroll domain includes information related to employee earnings and taxes. This includes elements from a typical pay statement, such as gross earnings, net earnings, federal / state income taxes and more.
payroll

Cardholders v1

Cardholder API Use Cases

  • Search for cardholders - basic cardholder details - the search is not AOID based
    POST /events/payroll/v1/paycard/cardholder.read
    GET /payroll/v1/paycard/cardholders?$filter=[any selection criteria, but SPI]
  • Get basic details of an individual cardholder such as demographic data, account ABA/DDA, account status, card status, etc.
    GET /payroll/v1/paycard/cardholders/{aoid}
  • Get alternate funding status during self-enrollment (status or account ABA/DDA)
    GET /payroll/v1/paycard/cardholders/{aoid}?$select=cardholderAccount
  • Get account data with transactions
    GET /payroll/v1/paycard/cardholders/{aoid}?$select= cardholderAccount&$expand=cardholderAccount/accountTransactions
  • Get extended cardholder profile details (without transactions)
    GET /payroll/v1/paycard/cardholders/{aoid}?$expand=profileDetails
payroll

Pay Distributions v2

Pay distributions determine how a worker's pay is divided (e.g. 50% to savings, 25% to checking, $100 on a paycard, and the remainder in check). The Pay Distributions APIs can be used to change how a worker's pay is distributed, retrieve a single distribution or list all distributions, or to obtain API metadata.
payroll

ATM Locator v1

The ATM Locator API returns a list of ATM locations within a specific radius.
payroll

Paycard Organization Locations v1

The Paycard Organization Locations APIs return all of the paycard locations that support paycard processing, details of a specified organization location.
payroll

Tax Statements v1

Worker Tax Statements APIs support the viewing of worker Tax Statements (e.g. (in US) W-2, 1099), and the details of each tax statement.
payroll

Paycard Disclosures v1

The API returns disclosures that must be agreed to before using certain features, e.g. ADP Marketplace, Aline Paycard, etc.
payroll

Paycard Consumer Fees v1

The API returns consumer fees that must be agreed to before using certain features of the Aline Paycard
payroll

Pay Data Input v1

Pay data input is a one-time payroll change, such as a charity deduction, for a worker. The Pay Data Input v1 APIs are used to add, modify, or replace pay data input for a worker, or to view all of the pay data inputs appllied to a worker. API metadata is also available.
payroll

Payroll Outputs v1

This API is used to convey the output of a payroll run
View more