---
title: "List payment methods"
method: GET
path: "/v1/account/payment-methods"
tags: ["account"]
---

# List payment methods

`GET /v1/account/payment-methods`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/payment-methods`
- Auth: HTTP bearer

Returns the workspace's saved payment methods, including cards and ACH bank accounts. When there are two or more methods and none is the backup, one method that is not the primary is made the backup.

**Notes.**
- A read that can write: with two or more methods and no backup, the handler makes one non-primary method the backup and records it in the audit log.

## Response `200`

Success.

- object
  - `data` object, required
    - `configured` boolean, required: False when billing is not set up (or could not be read, see `reason`).
    - `sources` object[], required
      - `id` string, required
      - `type` string, required: `card`, `bank_account`, or a wallet type (`apple_pay`, `paypal_express_checkout`, …).
      - `brand` string, nullable, required
      - `last4` string, nullable, required
      - `walletType` string, nullable, required
      - `gateway` string, nullable, required
      - `expiryMonth` integer, nullable, required
      - `expiryYear` integer, nullable, required
      - `status` string, required
      - `primary` boolean, required
      - `backup` boolean, required: Charged when the primary fails.
    - `reason` string

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)