Skip to main content

PaymentsResponse

Paginated response containing payment records with navigation metadata.

Includes payment data along with pagination controls for efficient data browsing and client-side state management. Supports response expansion to include related transaction details.

type PaymentsResponse {
  items: [Payment!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}

Fields​

PaymentsResponse.items ● [Payment!]! non-null object​

List of items of type Payment

PaymentsResponse.itemsFound ● Int! non-null scalar​

Total number of items found

PaymentsResponse.offset ● Int! non-null scalar​

The amount of items to show per page

PaymentsResponse.page ● Int! non-null scalar​

The current page

PaymentsResponse.pages ● Int! non-null scalar​

Total amount of pages

PaymentsResponse.start ● Int! non-null scalar​

Start position of the current page

PaymentsResponse.end ● Int! non-null scalar​

End position of the current page

Returned By​

payments query