GET
/
payment-requests

Parameters

status
string

Only return payment requests in this status, one of pending, approved, declined or processed.

limit
string

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after
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.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Returns

A dictionary with a payment_requests property that contains an array of Payment Request objects.