---
title: "Get Payee List"
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/billpayPayees"
tags: ["BillPay"]
---

# Get Payee List

`GET /programs/{programCode}/accounts/{accountIdentifier}/billpayPayees`

Retrieves all active payees for a given account. This endpoint allows a list of all active payees to be retrieved according to their accountIdentifier.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetPayeeListResponse — Get Payee List Response – Contains a list of all payees associated with a specific account. Used to provide detailed information about each payee, including status, type, name, address, and contact details.
  - `payees` PayeeDetail[], nullable — The list of payee details for the account. Each item contains information such as payee identifier, status, type, name, address, and contact information.
    - `payeeIdentifier` string, nullable — The unique identifier assigned to the payee.
    - `payeeStatus` 'active' | 'inactive', nullable — The status of the payee (e.g., Active, Inactive). See Gd.Bos.DataTransfer.PayeeDetail.PayeeStatus.
    - `payeeType` 'person' | 'merchant', nullable — The type of payee (e.g., Merchant, Person). See Gd.Bos.DataTransfer.PayeeDetail.PayeeType.
    - `name` string, nullable — The name of the payee (merchant or person).
    - `nickName` string, nullable — An optional nickname for the payee.
    - `address1` string, nullable — The first line of the payee's address.
    - `address2` string, nullable — The second line of the payee's address (optional).
    - `city` string, nullable — The city of the payee's address.
    - `state` string, nullable — The state or province of the payee's address.
    - `zip` string, nullable — The ZIP or postal code of the payee's address.
    - `country` string, nullable — The country of the payee's address (e.g., "US").
    - `accountNumber` string, nullable — The account number associated with the payee, if applicable.
    - `phoneNumber` string, nullable — The payee's phone number.
    - `email` string, nullable — The payee's email address.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)