GET
/
payments

Returns a list of Payment objects.

Query Parameters

source
string

The ID of the Payment's source.

destination
string

The ID of the Payment's destination.

acc_id
string

The ID of either the Payment's source or destination.

source_holder_id
string

The ID of the Payment's source holder (Entity).

destination_holder_id
string

The ID of the Payment's destination holder (Entity).

holder_id
string

The ID of either of the Payment's source or destination holder (Entity).

status
string

The Payment's status.

from_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Payments created on and after the date provided.

to_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Payments created on and before the date provided.

page
string

The number of the page to return.

page_cursor
string

The ID of a resource from which a page should start or end. Mutually exclusive with page.

page_limit
string

The number of Payments to return per page.

Returns

Returns a list of Payment objects.