v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Cards on file

Get card on file

Get card on file

Note: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment.

get/cardsonfile/v2/cardsonfile/cards/{cardid}

Path parameters

cardidstring required

Card ID

Headers

Authorizationstring required

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in an <b>Unauthorized</b> message.

Response

acquirerstring

Acquirer ID.

card_namestring

Card alias name. No limit.

card_profilestring

Network card profile identifier or HEX color. A profile or HEX color determines a card's appearance in a mobile payment app or payment system. Issuers are responsible for configuring card profiles with the card network.

pismo_card_idinteger

Pismo card ID

customer_idinteger

Pismo customer ID.

program_idnumber

Pismo program ID.

card_status'ACTIVE' | 'SUSPENDED' | 'PENDING'

Card status

creation_datestring

Creation date in RFC3339 format.

default_cardboolean

Is this card the default card? Default is false.

document_numberstring

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

expiration_datestring

Card expiration date (mmyy)

first_6_digitsstring

First 6 PAN digits

issuer_cardboolean

Is this the issuer's card? Default is false.

last_4_digitsstring

Last 4 PAN digits

network'AMEX' | 'MASTERCARD' | 'VISA' | 'UNKNOWN'

Card network that provisioned card

panstring

Primary Account Number (PAN) to store. The PAN shown here is a fictional example used for documentation purposes. It does not represent a real card number.

printed_namestring

Printed name on physical card

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

verifiedboolean

Is card verified? Default is false.

Example response

[
  {
    "pan": "4556360876754431",
    "expiration_date": "0228",
    "printed_name": "Beverly Hills",
    "acquirer": "38847",
    "verified": false,
    "card_status": "ACTIVE",
    "pismo_card_id": 123,
    "custom_id": 123456,
    "program_id": 1234567,
    "last_4_digits": "4431",
    "first_6_digits": "455636",
    "creation_date": "2022-05-20T11:40:22.287Z",
    "card_name": "Primary card",
    "document_number": "72437914099",
    "card_profile": "profile 01",
    "default_card": true,
    "issuer_card": false,
    "network": "VISA",
    "metadata": "{ \"address\": \"st main 01, center, nashville - FA\" }"
  }
]