Fields to configure the payment. Takes all fields from the /payment endpoint. All fields are optional.
start_date
string
start_date
string
end_date
string
end_date
string
pay_statements
array
pay_statements
array
curl--request POST \--url https://api.tryfinch.com/sandbox/payment \--header'Authorization: Bearer <token>'\--header'Content-Type: application/json'
{"payment_id":"<string>","pay_date":"<string>"}
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
headerrequired
Please use your Access Token
Body
application/json
start_date
string
end_date
string
pay_statements
object[]
pay_statements.individual_id
string
A stable Finch id (UUID v4) for an individual in the company
pay_statements.type
enum<string> | null
The type of the payment associated with the pay statement.
Available options:
regular_payroll,
off_cycle_payroll,
one_time_payment,
pay_statements.payment_method
enum<string> | null
The payment method.
Available options:
check,
direct_deposit,
pay_statements.total_hours
number | null
The number of hours worked for this pay period
pay_statements.gross_pay
object | null
pay_statements.gross_pay.amount
integer | null
Amount for money object (in cents)
pay_statements.gross_pay.currency
string
pay_statements.net_pay
object | null
pay_statements.net_pay.amount
integer | null
Amount for money object (in cents)
pay_statements.net_pay.currency
string
pay_statements.earnings
array | null
The array of earnings objects associated with this pay statement
pay_statements.earnings.type
enum<string> | null
The type of earning.
Available options:
salary,
wage,
reimbursement,
overtime,
severance,
double_overtime,
pto,
sick,
bonus,
commission,
tips,
1099,
other,
pay_statements.earnings.name
string | null
The exact name of the deduction from the pay statement.
pay_statements.earnings.amount
integer | null
The earnings amount in cents.
pay_statements.earnings.currency
string | null
The earnings currency code.
pay_statements.earnings.hours
number | null
The number of hours associated with this earning. (For salaried employees, this could be hours per pay period, 0 or null, depending on the provider).
pay_statements.taxes
array | null
The array of taxes objects associated with this pay statement.
pay_statements.taxes.type
enum<string> | null
The type of taxes.
Available options:
state,
federal,
local,
fica,
pay_statements.taxes.name
string | null
The exact name of tax from the pay statement.
pay_statements.taxes.employer
boolean | null
true if the amount is paid by the employers.
pay_statements.taxes.amount
integer | null
The tax amount in cents.
pay_statements.taxes.currency
string | null
The currency code.
pay_statements.employee_deductions
array | null
The array of deductions objects associated with this pay statement.
