Any time you want pay a worker on your team, you will create a 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

id
string

Unique identifier for the payment, e.g. pt_1HPCXADYAhh5k1NMU0r1WUqs.

worker
string

ID of the worker paid.

account
string

ID of the bank account payment was made to.

date
date

Date of the payment.

amount
string

Amount of the payment, in decimal format.

currency
string

Three-letter ISO currency code, in uppercase.

status
string

The status of the payment. Possible values are pending, processing, paid, failed, cancelled or split.

reference
string

A reference for this payment visible on the recipient’s bank statement.

note
string

An additional memo included alongside the payment.