Skip to main content

PayMethodSearchInput

Search criteria for filtering payment methods with comprehensive options.

Provides flexible search capabilities for payment method discovery including date range filtering, identifier-based searches, and custom sorting. Supports pagination for large payment method catalogs.

input PayMethodSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  ids: [Int!]
  externalCodes: [String!]
  sortInputs: [PayMethodSortInput!]
}

Fields​

PayMethodSearchInput.page ● Int scalar​

Page number for pagination.

Specifies which page of results to return. Must be a positive integer (minimum value: 1). Default is page 1.

PayMethodSearchInput.offset ● Int scalar​

Number of items per page.

Controls how many payment methods are returned in each page. Must be a positive integer (minimum value: 1). Default is 12 payment methods per page.

PayMethodSearchInput.createdAt ● DateSearchInput input​

Filter by payment method creation date range.

Allows filtering payment methods based on when they were originally created in the system. Useful for finding recently added payment methods.

PayMethodSearchInput.lastModifiedAt ● DateSearchInput input​

Filter by payment method last modification date range.

Allows filtering payment methods based on when they were last updated. Useful for finding recently modified payment methods or tracking changes.

PayMethodSearchInput.ids ● [Int!] list scalar​

Filter by specific payment method identifiers.

Returns only payment methods whose IDs match the provided list. Each ID must be a positive integer (minimum value: 1) and unique within the array. Useful for retrieving specific payment methods or bulk operations.

PayMethodSearchInput.externalCodes ● [String!] list scalar​

Filter by external system codes.

Returns payment methods matching any of the specified external codes used for payment processor integration. Each code must follow SCREAMING_SNAKE_CASE format (pattern: ^([A-Z]_?[A-Z])*$), have maximum length of 64 characters, and be unique within the array.

PayMethodSearchInput.sortInputs ● [PayMethodSortInput!] list input​

Sorting configuration for result ordering.

Defines how the payment method results should be sorted, supporting multiple sort criteria with different directions (ascending/descending). Each sort input must be unique within the array.

Member Of​

payMethods query