---
title: "Get a List of Payers"
method: GET
path: "/v1/payments/payers"
tags: ["Payers"]
---

# Get a List of Payers

`GET /v1/payments/payers`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/v1/payments/payers`
- Auth: API key in header `Authorization`

You can retrieve a list of the Payers you've created by sending a GET request to: /v1/payments/payers

A successful response returns an array that contains identifying information for each of the Payers, including the PayerId, the name of the institution, and the last four digits of the account number.

## Response `200`

- GetPayersResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` PayerResponse[], required
    - `payerId` string, required
    - `userId` string: Will be available only for payerType 'USER'
    - `payerType` string, required: Payer type. Possible values: USER, PARTNER, SETTLEMENT
    - `payerSubType` string, required
    - `label` string: Human-readable label for the payer. Only present for SETTLEMENT payers.
    - `accountLast4Digits` string, required
    - `institutionName` string, required
    - `tokenType` 'PLAID'
    - `verificationStatus` VerificationStatusResponseData
      - `status` 'IN_PROGRESS' | 'UNVERIFIED' | 'VERIFIED' | 'FAILED' | 'ERROR' | 'APPROVED_AWAITING_USER', required
      - `statusUpdateTs` number, required
    - `createdOn` number, required
    - `updatedOn` number, required

## Other responses

- `400`: Bad request response
- `401`: Unauthorized response
- `404`: Not found response
- `500`: Internal server error response

---

[API](https://skmtc.dev/spinwheel/apis/pay.md) - [All operations](https://skmtc.dev/spinwheel/apis/pay/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/pay/revisions/58ba91f8ae13?raw)