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
string
Unique identifier for the object.
string
The ID of the worker who submitted this request.
string
The amount requested in decimal format.
string
Three-letter ISO currency code, in uppercase.
string
The status of the payment request. Possible values are
pending, approved, declined or
processed. Withdrawn requests are returned as cancelled.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.
string
An additional memo describing the request. This memo will not be included in the payment.
string
An period this request is related to.
string[]
An array containing IDs for all documents attached to this payment request.
string[]
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.
string
When completed, the ID of the Payment associated with this Payment Request.