v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Cards on file

Update card on file

Updates a card on file - change the card name, status, or profile. You must pass the card uuid token as a body parameter to identify the card.

Fields that are not passed are not updated.

This endpoint generates a Card on file updated event. If the card status is being changed to SUSPENDED, it also generates a Card excluded event.

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

patch/cardsonfile/v2/cardsonfile/cards

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.

Request body

card_stored_uuidstring required

API-generated card token from registration. This is NOT a field you can change, but it must be passed to identify the card.

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.

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.

status'' | 'ACTIVE' | 'SUSPENDED'

Card-on-file token status - ACTIVE or SUSPENDED.

Example request

{
  "card_name": "National Bank MC",
  "card_profile": "0XFF00FF",
  "card_stored_uuid": "77cdd87e-b9b6-11ec-b4f5-4a7a44f81261",
  "metadata": "{'Bank': 'National MC'}",
  "status": "SUSPENDED"
}

Response

SUCCESS