---
title: "List cards"
method: POST
path: "/v1/cards/list"
tags: ["UPI"]
---

# List cards

`POST /v1/cards/list`

## Request

- Base URL: `https://sandbox.pismolabs.io/upi-gateway`
- URL: `https://sandbox.pismolabs.io/upi-gateway/v1/cards/list`
- Auth: HTTP bearer

Return active account card list

## Headers

- `Authorization` string, required
- `user-agent` string, required

## Request body

- CardsListCardsRequest
  - `external_transaction_datetime` string, required: Request datetime. ISO 8601 format.
  - `external_transaction_id` string, required: Request ID code
  - `phone` Phone, required
    - `country_code` string, required: Phone number country code
    - `phone` string, required: Phone number
    - `area_code` string: Phone number area code
  - `type` '' | 'PLASTIC' | 'VIRTUAL' | 'TEMPORARY': Pismo card type. For more information, see [Cards management](https://developers.pismo.io/pismo-docs/docs/cards-overview-1#card-types). Default is empty string, meaning all card types are returned.

## Response `200`

Response Body

- CardsListCardsResponse
  - `cards` CardsCardsData[], required: Account cards
    - `account_reference_number` string, required: Account reference number. Pismo creates this automatically when creating a card linked to RuPay on UPI. This number combines 10 BIN digits and the credit account number. If BIN is 6 digits, the remaining 4 digits are set to zero (`0`). If BIN is 8 digits, then the remaining 2 digits are set to zero. This is a [NPCI](https://www.npci.org.in/what-we-do/rupay/product-overview) standard. For example, if the account reference number = `1234560000987654321`, the first six digits are the BIN, appended with 4 zeros and then the credit account number (`987654321``). You can call [List cards](ref:post-list-cards) to get a card's account reference number.
    - `bin` string, required: Card Bank Identification Number (BIN)
    - `masked_number` string, required: Card masked number
    - `printed_name` string, required: Card printed name
    - `status` string, required: Card status. For more information, see [Card lifecycle and statuses](https://developers.pismo.io/pismo-docs/docs/card-lifecycle-and-statuses).
    - `type` '' | 'PLASTIC' | 'VIRTUAL' | 'TEMPORARY', required: Pismo card type. For more information, see [Cards management](https://developers.pismo.io/pismo-docs/docs/cards-overview-1#card-types). Default is empty string, meaning all card types are returned.
  - `external_transaction_datetime` string, required: Request datetime. ISO 8601 format.
  - `external_transaction_id` string, required: Request ID code
  - `owner` CardsOwner, required
    - `name` string, required: Owner name
  - `phone` Phone, required
    - `country_code` string, required: Phone number country code
    - `phone` string, required: Phone number
    - `area_code` string: Phone number area code

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: UnprocessableEntity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/instant-payments-rupay-on-upi.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-rupay-on-upi/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-rupay-on-upi/revisions/892669202dfc?raw)