Skip to main content
POST
JavaScript
All fields are optional. If you don’t provide a start and end date, the default start_date is one business day after the end_date of the most recently created payment, and the default end_date is start_date + 14 business days. The default pay_date is the end_date and the default debit_date is one business day after the pay_date. You may override any fields in the pay statements you would like. By default, no taxes, earnings or deductions are created (unless an individual is enrolled in deductions via the /benefits endpoints).

Authorizations

Authorization
string
header
required

Please use your Access Token

Body

application/json

Fields to configure the payment. Takes all fields from the /payment endpoint. All fields are optional.

Fields to configure the payment. Takes all fields from the /payment endpoint. All fields are optional.

start_date
string<date>
end_date
string<date>
pay_statements
object[]

Array of pay statements to include in the payment.

Maximum array length: 10000

Response

200 - application/json

OK

payment_id
string

The ID of the payment.

pay_date
string

The date of the payment.