---
title: "GET /user/paymethods"
method: GET
path: "/user/paymethods"
---

# GET /user/paymethods

`GET /user/paymethods`

## Request

- Base URL: `https://developers.whmcs.com/api/v2`
- URL: `https://developers.whmcs.com/api/v2/user/paymethods`
- Auth: none declared

Retrieve the authenticated client's stored payment methods.

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

The client's stored payment methods, if any exist, starting with the default payment method.

- object
  - `data` PayMethod[], required
    - `id` integer, required: Pass this value as the `payment.paymethod_id` value when checking out a cart to pay with this stored method.
    - `type` string, required: How WHMCS stores the method internally.
    - `kind` 'card' | 'wallet' | 'bank_account', nullable, required: The type of payment method. A `null` value indicates that the system could not find the payment method's stored details.
    - `description` string, required: The client's label for this method, if they set one.
    - `gateway` string, required: The payment gateway module for this payment method.
    - `gateway_is_active` boolean, required: Whether the payment gateway is currently active on this installation. If the payment gateway is not currently active, the client cannot pay using this method.
    - `is_default` boolean, required: Whether this is the client's default payment method. Exactly one of a client's methods is the default.
    - `label` string: A short human-readable display name for the payment method.
    - `card_type` string: The card brand, if the `kind` value is `card`.
    - `card_last_four` string: The last four digits of the card. Present only when `kind` is `card`.
    - `expiry_date` string, nullable: The card expiry date in the `MM/YY` format, if the `kind` value is `card`. This value is `null` when the stored method does not have an expiry date.
    - `is_expired` boolean: Whether that expiry date has passed, if the `kind` value is `card`. If the expiry date has passed, the client cannot pay using this method.
    - `bank_name` string, nullable: The bank holding the account, if the `kind` value is `bank_account`. This value is `null` when the gateway did not supply bank information.

## Other responses

- `401`: Access Not Authorized
- `403`: The caller is authenticated but does not have permission to use this resource (the _View & Pay Invoices_ permission).
- `default`: General Error

---

[API](https://skmtc.dev/whmcs/apis/whmcs-api.md) - [All operations](https://skmtc.dev/whmcs/apis/whmcs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whmcs/apis/whmcs-api/revisions/bd3848ddbc3f?raw)