Retrieve Payment List

Query Params

start_date

int64

The start date for the search, specified as a Unix timestamp. This applies to the payment request's creation date.

end_date

int64

The end date for the search, specified as a Unix timestamp. This applies to the payment request's creation date.

limit

int32

Defaults to 10

The number of records to retrieve. If not provided it defaults to 10.

page

int32

Defaults to 1

The page to retrieve based on the limit parameter provided. If not provided it defaults to 1.

display_status

array of strings

The display status for the search. Possible values are: succeeded, failed, refunded and processing.

display_status

payment_method

array of strings

The payment methods for the search. Possible values are: card and us_bank_account.

payment_method

customer

string

The customer ID for the search.

string

Search by last4 of payment method, customer name, customer email, and description.

order_by

array of strings

Defaults to created:desc

The parameters and the directions to sort by. Parameters allowed: created and amount. E.g. created:desc

order_by

expand

array of strings

Parameters to expand in the response. Allowed parameters: customer.

expand

Headers

onBehalfOf

string

Specifies the account for which the Payment Request list retrieval is intended. This is used for scenarios where one partner processes payments on behalf of another partner, such as in PayFac or related partner relationships.

200200

400400