requestedPayments

Fetch paginated Requested Payments collection

Arguments

keywords · String · Filters results by matching against invoice ID or a full-text search on requested payment fields.

only_unpaid · Boolean · DEPRECATED: Use status_filter instead

preview · Boolean · When true, includes preview requested payments that have not yet been formally created.

sender_id · ID · Filters for requested payments where this ID matches the sender or recipient.

status_filter · String · Can be paid, partial or unpaid.

sort_by · String · DEPRECATED: Use order_by instead.

order_by · RequestedPaymentOrderKeys · Specifies the field and direction by which to sort the requested payments results.

after · String · Returns the elements in the list that come after the specified cursor.

before · String · Returns the elements in the list that come before the specified cursor.

first · Int · Returns the first _n_ elements from the list.

last · Int · Returns the last _n_ elements from the list.

Returns

RequestedPaymentPaginationConnection

Example

query requestedPayments(
  $keywords: String
  $only_unpaid: Boolean
  $preview: Boolean
  $sender_id: ID
  $status_filter: String
  $sort_by: String
  $order_by: RequestedPaymentOrderKeys
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  requestedPayments(
    keywords: $keywords
    only_unpaid: $only_unpaid
    preview: $preview
    sender_id: $sender_id
    status_filter: $status_filter
    sort_by: $sort_by
    order_by: $order_by
    after: $after
    before: $before
    first: $first
    last: $last
  ) {
    edges
    nodes
    page_info
    total_count
  }
}