Sandbox
Add a new sandbox payment
POST
/
sandbox
/
payment
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
headerrequiredPlease use your Access Token
Body
application/json
Fields to configure the payment. Takes all fields from the /payment
endpoint. All fields are optional.
start_date
string
end_date
string
pay_statements
object[]
Response
200 - application/json
payment_id
string
The ID of the payment.
pay_date
string
The date of the payment.
Was this page helpful?