Request Early Pay

Processes a request for Early Pay on behalf of a worker. Automatically calculates and processes the payment, withholds taxes and fees appropriately, and prepares the net amount for a deposit transfer to the worker as soon as possible.

Body Params
string

Required if "external-worker-id" is false

string

Required if "worker-id" is false

string

A description for this Early Pay request. Displayed to workers on pay statements.

requestedAmount
object
required

The amount requested to pay-out on demand. This is an amount net of taxes and payroll deductions, but a fee may be deducted from this amount depending on configuration.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json