This endpoint lets you retrieve a worker's current Early Pay status, including total gross earnings and hours, reductions to earnings due to deductions and Early Pay limits, and the amount currently available to request for payout via Early Pay.

Availability Status

There are several conditions that must be met in order for Early Pay to be available to process a worker's request. The table below lists the possible values of the status.code field and their meanings:

Code	Explanation
`AVAILABLE`	Available to request.
`UNAVAILABLE_NOT_ENOUGH_EARNINGS`	There aren't enough earnings available for the worker to make a request.
`UNAVAILABLE_MAX_REQUESTS_REACHED`	The worker has already made the maximum number of requests in the current pay period.
`UNAVAILABLE_FEATURE_DISABLED`	Early Pay is disabled at the company instance level.
`UNAVAILABLE_ANOTHER_REQUEST_PROCESSING`	Another request is still processing.
`UNAVAILABLE_NOT_ON_PAY_CYCLE`	The worker isn't paid on a regular pay cycle basis.
`UNAVAILABLE_UNSUPPORTED_PAY_CYCLE`	The worker is paid on a pay cycle basis that's not currently supported.
`UNAVAILABLE_WORKER_NOT_ACTIVE`	The worker either hasn't yet reached their hire date, or is past their termination date.
`UNAVAILABLE_FINAL_PAY_PERIOD`	The worker is in their final pay period before termination.
`UNAVAILABLE_NOT_HOURLY_PAY`	The worker is not configured with an hourly pay type.

200200