# List Payment Methods

**GET /payment-methods**

Returns a paginated list of payment methods that have been configured in the system for the authenticated merchant.

IDs of both "Physical" payment terminals that can be used to process Card Present transactions and IDs of "Virtual" terminals (hosted payment forms / iframes) that can be used to process Card Not Present transactions will be returned.

### Filtering and Sorting

You can filter and sort the results using query parameters:

#### Available Filter/Sort Fields:
- `id` - Payment method ID
- `paymentMethodType` - Type of payment method (Physical, Virtual)
- `currency` - Currency (USD, CAD)
- `description` - Payment method description
- `ownerId` - The Merchant ID that owns this Payment Method ID

#### Filter Operators:

| Operator | Meaning |
|----------|---------|
| `==` | Equals |
| `!=` | Not equals |
| `>` | Greater than |
| `<` | Less than |
| `>=` | Greater than or equal to |
| `<=` | Less than or equal to |
| `@=` | Contains |
| `_=` | Starts with |
| `_-=` | Ends with |
| `!@=` | Does not Contains |
| `!_=` | Does not Starts with |
| `!_-=` | Does not Ends with |
| `@=*` | Case-insensitive string Contains |
| `_=*` | Case-insensitive string Starts with |
| `_-=*` | Case-insensitive string Ends with |
| `==*` | Case-insensitive string Equals |
| `!=*` | Case-insensitive string Not equals |
| `!@=*` | Case-insensitive string does not Contains |
| `!_=*` | Case-insensitive string does not Starts with |

#### Examples:
- Filter by type: `?filters=paymentMethodType==Physical`
- Multiple filters: `?filters=paymentMethodType==Physical,currency==USD`
- Sort results: `?sorts=paymentMethodType,description`
- Combined: `?filters=currency==USD&sorts=description`



## Servers
- https://api.omni.integratedcommerce.io/v1: https://api.omni.integratedcommerce.io/v1 ()


## Authentication methods
- Api key header


## Parameters


### Query parameters
- **filters** (string)
  Filter criteria in the format: field==value,field!=value
  Multiple filters can be separated by commas.
  Available fields: id, paymentMethodType, currency, description, ownerId
- **sorts** (string)
  Sort criteria as comma-separated field names.
  Available fields: id, paymentMethodType, currency, description, ownerId
- **page** (integer)
  Page number to retrieve (starts at 1).
  For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.
- **pageSize** (integer)
  Number of records per page.
  For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.


## Responses
### 200
A successful paginated response containing available payment methods

#### Body: application/json (object)
- **totalCount** (integer)
  Total number of payment methods that match the filter criteria
- **page** (integer)
  The current page number (starts at 1)
- **pageSize** (integer)
  Number of items per page
- **totalPages** (integer)
  Total number of pages available
- **hasNextPage** (boolean)
  True if there are more pages of results available
- **hasPreviousPage** (boolean)
  True if there are previous pages of results available
- **items** (array[object])
  Array of payment methods for the current page

### 401
Unauthorized response due to an invalid or missing API key.

#### Body: application/json (object)
- **code** (number)
  Numeric error code. These are grouped into ranges for easier identification and troubleshooting.

   * `1000` - AuthenticationGenericError
   * `2000` - RequestValidationGenericError
   * `3000` - UnknownServerGenericError
   * `9000` - UnhandledGenericError
- **status** (string)
  Execution status of the request sent to the payment gateway.

   * Completed - The request completed successfully.
   * Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried.
   * Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction.
   * Unknown
- **message** (string)
  Developer-facing error message.
- **traceId** (string)
  Unique trace identifier for tracking and debugging this request.
- **timestamp** (string(date-time))
  The timestamp when the error occurred (UTC).
- **errorDetails** (array[object])



[Powered by Bump.sh](https://bump.sh)