Payment
{
"id": "pt_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"date": "2023-09-01",
"metadata": {},
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
}
}
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
Unique identifier for the payment, e.g. pt_1HPCXADYAhh5k1NMU0r1WUqs.
ID of the worker paid.
ID of the bank account payment was made to.
Date of the payment.
Amount of the payment, in decimal format.
Three-letter ISO currency code, in uppercase.
The status of the payment. Possible values are pending, processing, paid, failed, cancelled or split.
A reference for this payment visible on the recipient’s bank statement.
An additional memo included alongside the payment.
Was this page helpful?
{
"id": "pt_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"date": "2023-09-01",
"metadata": {},
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
}
}