---
title: "Get Custom Card"
method: GET
path: "/programs/{programCode}/userIdentifiers/{userIdentifier}/getCustomCard"
tags: ["CustomCard"]
---

# Get Custom Card

`GET /programs/{programCode}/userIdentifiers/{userIdentifier}/getCustomCard`

Retrieve and use the Custom Card ID to request a custom card. How it works:
- Call GET /programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}
- If a custom card is available, your response will contain the customCardImageIdentifier field, which is a unique identifier for the custom card.
- Call GET /programs/{programCode}/userIdentifiers/{userIdentifier}/getCustomCard?customCardImageIdentifier=GUID
	- Search for the custom card you are looking for using the customCardImageIdentifier.
	- If the custom card is found, you will receive a response containing the custom card information.
	- If the custom card is not found, you will receive the following:
		- Code: 4
		- Subcode: 1024
		- Description: customCardImageIdentifier not found or not supplied.

Note: GET customCard can be called with or without the customCardImageIdentifier. Sample response: GET paymentInstrument element.

## Path parameters

- `programCode` string, required
- `userIdentifier` string, required

## Query parameters

- `customCardImageIdentifier` string

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetCustomCardResponse — Represents the response returned after retrieving custom card information. Contains a list of custom cards with status, activity, order, and image details. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `customCard` CustomCard[], nullable — The list of custom cards returned by the operation. Each Gd.Bos.DataTransfer.Response.ResponseObjects.CustomCard includes card status, activity, order date, and associated images.
    - `status` string, nullable — The current status of the custom card.
    - `isActive` boolean — Indicates whether the custom card is currently active.
    - `attemptsRemaining` integer — The number of remaining attempts for the custom card.
    - `orderDate` string, date-time — The date when the custom card was ordered.
    - `customImage` CustomCardImage — Represents a custom card image returned in a response. Contains image status, reason, thumbnail data, and a unique image identifier.
      - `imageStatus` string, nullable — The current status of the custom card image (e.g., "Active", "Rejected", "Pending").
      - `statusReason` string, nullable — The reason or description for the current image status.
      - `thumbNail` string, byte, nullable — The thumbnail image data for the custom card image.
      - `customCardImageIdentifier` string, nullable, required — The unique identifier for the custom card image.
  - `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/versions/666553766b78/schema)