---
title: "Search payment accounts"
method: GET
path: "/v1/PaymentAccounts"
tags: ["PaymentAccounts"]
---

# Search payment accounts

`GET /v1/PaymentAccounts`

Search for one or more payment accounts.

## Query parameters

- `search.payment_account_id` integer[]
- `search.card_expiration_date_start` string, date-time
- `search.card_expiration_date_end` string, date-time
- `search.bank_account_name` string[]
- `search.bank_account_type` string[]
- `search.bank_name` string[]
- `search.method` string[]
- `search.card_name_first` string[]
- `search.card_name_last` string[]
- `search.token` string[]
- `search.merchant_profile_id` integer[]
- `search.last_used_start` string, date-time
- `search.last_used_end` string, date-time
- `search.last_process_result` string[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.created_by` integer[]
- `search.last_4` string[]
- `search.customer_id` integer[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsPaymentAccountsPaymentAccountModel
  - `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` RevAppModelsPaymentAccountsPaymentAccountModel[] — List of records returned.
    - `payment_account_id` integer — Primary identifier for this payment account.
    - `address_id` integer — Foreign identifier for the address used for the billing address.
    - `method` 'CC' | 'ACH' — The method used by this account to electronically process a payment.
    - `last_used` string, date-time — Date and time this account was last used to make a payment.
    - `last_process_result` 'NONE' | 'DECLINED' | 'APPROVED' | 'ERROR' — Result of the last attempted payment using this payment account.
    - `created_date` string, date-time — Date and time that this payment account was created.
    - `created_by` integer — Foreign identifier indicating the user who created this payment account.
    - `last_4` string — The last four digits of the credit card or bank account, depending on the method.
    - `token` string — The token assigned by the payment gateway and used for secure payment transacting.
    - `merchant_profile_id` integer — Foreign identifier indicating the merchant profile associated with this payment account.
    - `bank_account` RevAppModelsPaymentAccountsBankModel
      - `account_name` string — The name on the bank account.
      - `account_type` 'CHECKING' | 'SAVINGS' — Indicates the type of bank account.
      - `bank_name` string — Name of the bank at which this account resides.
      - `routing_number` string — The bank routing number.
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `credit_card` RevAppModelsPaymentAccountsCardModel
      - `expiration_date` string, date-time — A short description of the payment method.
      - `name_first` string — First name of the card holder.
      - `name_last` string — Last name of the card holder.
      - `brand` 'AMEX' | 'DISCOVER' | 'DINERS' | 'CC' | 'VISA' | 'MASTERCARD' — Indicates the brand of card recorded in this payment account.
    - `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)