---
title: "Search payment methods"
method: GET
path: "/v1/PaymentMethods"
tags: ["PaymentMethods"]
---

# Search payment methods

`GET /v1/PaymentMethods`

Search for one or more payment methods.

## Query parameters

- `search.payment_method_id` integer[]
- `search.description` string[]
- `search.cc_enabled` boolean
- `search.erate_enabled` boolean
- `search.ach_enabled` boolean
- `search.show_in_customer_portal_flag` boolean
- `search.show_in_agent_portal_flag` boolean
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsPaymentMethodModel
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsPaymentMethodModel[] — List of records returned.
    - `payment_method_id` integer — Primary identifier for this payment method.
    - `description` string — A short description of the payment method.
    - `order_index` integer — Indicates the order in which the method should be listed relative to others in ascending numerical order.
    - `cc_enabled` boolean — Indicates that this method will facilitate an electronic credit card payment.
    - `ach_enabled` boolean — Indicates that this method will facilitate an electronic check or ACH payment.
    - `erate_enabled` boolean — Indicates that this method supports the eRate feature for government reimbursement.
    - `fee_description` string — A description of the fee applied to any payment by this method. Only applicable if fee_amount is greater than zero.
    - `fee_amount` number, double — The amount of fee to apply to any payment by this method. It can represent a flat fee: 4.00 = $4.00. It can represent a percentage based on the payment amount: 4.00 = 4.00%. Which representation is indicated by the fee_type value.
    - `fee_type` 'FLAT' | 'PERCENT' — Indicates what the fee_amount value represents.
    - `fee_applied_to_auto_debit` boolean — Indicates that the fee should also apply to auto debit payments.
    - `shows_in_customer_portal` boolean — Indicates that this method is available to choose in the customer portal.
    - `shows_in_agent_portal` boolean — Indicates that this method is available to choose in the agent portal.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)