{
  "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
  "worker": "wr_anqRSFcK36ie85",
  "amount": "1200.00",
  "currency": "EUR",
  "status": "pending",
  "reference": "EV1S3GDM",
  "note": "Payment for July",
  "period": {
    "starts": "2023-07-01",
    "ends": "2023-07-31"
  },
  "documents": [],
  "approvals": [],
  "payment": null
}
A Payment Request is created every time a Worker on your team submits a request to be paid. This can be used to faciliate bill payments or invoice workflows, where the amount you’re going to pay to the worker isn’t known ahead of time.

​
Attributes

​
id
string
Unique identifier for the object.
​
worker
string
The ID of the worker who submitted this request.
​
amount
decimal
The amount requested in decimal format.
​
currency
string
Three-letter ISO currency code, in uppercase.
​
status
string
The status of the payment request. Possible values are pending, approved, declined or processed.
​
reference
string
A reference for this payment request submitted by the worker. Most commonly used to include an invoice number. This will be automatically entered as the payment reference when this request is paid.
​
note
string
An additional memo describing the request. This memo will not be included in the payment.
​
period
string
An period this request is related to.
​
documents
array
An array containing IDs for all documents attached to this payment request.
​
approvals
array
An array containing IDs for all approvals associated with this request.Note: Declined approvals will also be listed here, so you shouldn’t rely on the presence of items in this field to indicate that the request has been approved.
​
payment
string
When completed, the ID of the Payment associated with this Payment Request.
{
  "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
  "worker": "wr_anqRSFcK36ie85",
  "amount": "1200.00",
  "currency": "EUR",
  "status": "pending",
  "reference": "EV1S3GDM",
  "note": "Payment for July",
  "period": {
    "starts": "2023-07-01",
    "ends": "2023-07-31"
  },
  "documents": [],
  "approvals": [],
  "payment": null
}