Skip to main content
GET
List payments

Parameters

number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
The cursor from the previous response, to fetch the next page. Treat it as opaque.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
string
Only return payments to this worker, such as wr_yLSx6.
string
Only return payments with this status: draft, created, pending, processing, paid, failed, cancelled, refunded or split.

Returns

A dictionaty with a payments property that contains an array fo up to limit payments. The response includes a cursor when another page exists. Each entry in the array is a separate payment object. If no more payments are available, the resulting array will be empty.