Payment.
Payments are always instructed using net amounts (after any taxes were deducted).
For example, a Payroll Item with gross earnings of 1,480 USD may result in a Payment of 1,100.23 USD.
This is sometimes referred to as the ‘check amount’.
Once a Payment is created, Plane will not take any deductions from it. It will be sent in full to the recipient
in the currency of their choice.
Attributes
string
Unique identifier for the payment, e.g.
pt_1HPCXADYAhh5k1NMU0r1WUqs.string
ID of the worker paid.
string
ID of the legal entity funding the payment.
string
Date of the payment.
string
Amount of the payment, in decimal format.
string
Three-letter ISO currency code, in uppercase.
string
The status of the payment. Possible values are
pending, processing, paid, failed,
cancelled or split.string | null
A reference for this payment visible on the recipient’s bank statement.
string | null
An additional memo included alongside the payment.
object | null
The period this payment covers.
object | null
Funding required to complete the payment.
object | null
How the payment amount splits across pay and expense reimbursement. Every amount is denominated in
currency, which is always the payment currency, and the amounts reconcile to amount as
compensation + reimbursement - deduction - withholding.This is null for payments that never recorded a breakdown, including payments generated by a
payroll run.