---
title: "Get User Payment Instrument List"
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments"
tags: ["PaymentInstrument"]
---

# Get User Payment Instrument List

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

Retrieves a List of Payment Instruments for a Specific Account

## Path parameters

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

## Query parameters

- `userIdentifier` string

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetPaymentInstrumentListResponse — Represents the response containing a list of payment instruments for a specific account.
  - `paymentInstruments` PaymentInstrumentLight[], nullable — The list of payment instruments associated with the account.
    - `userIdentifier` string, nullable — Unique identifier for the user associated with the payment instrument.
    - `paymentIdentifier` string, nullable — Unique identifier for the payment (may be used for transaction tracking).
    - `paymentInstrumentIdentifier` string, nullable — Unique identifier for the payment instrument.
    - `paymentInstrumentType` string, nullable — The type of payment instrument (e.g., "card", "virtualCard").
    - `status` string, nullable — The current status of the payment instrument (e.g., "active", "inactive", "blocked").
    - `statusReasons` string[], nullable — The list of reasons for the current status of the payment instrument.
    - `isPrimaryAccountHolder` boolean — Indicates whether the user is the primary account holder for this payment instrument.
    - `isPrivateDataViewable` boolean — Indicates if private card data is viewable in the response.
    - `isPinSet` boolean — Indicates whether the PIN has been set for this payment instrument.
    - `last4Pan` string, nullable — The last four digits of the payment instrument's PAN (Primary Account Number).
    - `activatedDateTime` string, nullable — The date and time when the payment instrument was activated, if applicable.
    - `issuedDateTime` string, nullable — The date and time when the payment instrument was issued.
    - `isOverIssuedDaysLimit` boolean, nullable — Indicates if the instrument is over the allowed days since issuance.
    - `customCardImageIdentifier` string, nullable — Identifier for a custom card image, if used.
  - `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)