Cards

Update card information

Update card information - name, transaction_limit, printed_name, contactless_enabled, abu_enabled, or metadata.<br>

This endpoint generates a Card updated event.

Note: This endpoint requires an account token—an access token encoded with a Pismo account ID.

patch/wallet/v2/cards/{cardId}

Request

Base URL
https://sandbox.pismolabs.io
URL
https://sandbox.pismolabs.io/wallet/v2/cards/{cardId}
Auth
HTTP bearer

Path parameters

cardIdstring required

Pismo card ID

Headers

x-customer-idinteger required

Pismo customer ID

Request body

namestring

Card alias name for a VIRTUAL card.

This field is REQUIRED to be unique for each VIRTUAL card a customer owns.

No matter what is passed for a PLASTIC card, the value is always PLASTIC.

printed_namestring

Printed/embossed card name.

Currently, you have 3 ways to populate this field:

During account creation via the application.applicant.personal.social_name field.
During account creation via the application.applicant.personal.name field when the field in #1 is not set.
Passing the printed_name field during card creation, updating a card, or when reissuing a card. This takes priority over #1 and #2.

No letters with accents, numbers, or special characters - only letters (a-z|A-Z) and space, as specified in the <a href="https://emvlab.org/emvtags/show/t5F20/" target="_blank">ISO EMV tag 5F20</a> for cardholder name.

REQUIRED for an UNNUMBERED card (Card created without PIN or PAN that issuer defines at some point in the future.)

transaction_limitstring

Optional for virtual cards. Maximum amount allowed per transaction. Set up to the approved limit. If not set, account limit is used.

contactless_enabledboolean

For physical cards. Is card enabled for contactless transactions?

With contactless transactions, you hold or tap the card on contactless-enabled card reader to complete a transaction. This requires that both the card and the terminal have Near Field Communication (NFC) technology. Most embossers can create plastic contactless cards.

Default is true.

abu_enabledboolean

To delete a card from the ABU database, submit Mastercard ABU reason code O (optout), and Mastercard will delete the card and all previous references to the card data chain. This prevents further merchant notifications. Removing a card from the ABU database using reason code O (Optout) does not result in associated MDES tokens being deleted. Mastercard maintains an audit trail for all deleted cards.

Set this field to falseto optout.

metadataMetadata

Any key-value object. Max length = 3200 bytes. This must be valid JSON data.

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.

Example request

{
  "name": "Vacation card",
  "transaction_limit": "500.00",
  "metadata": {
    "my-custom-key": "my-custom-value"
  }
}

Response

Card update response object

idinteger

Card ID

statusstring

Card status enum. Refer to the Card lifecycle and statuses guide for more information and a complete list.

printed_namestring

Printed/embossed card name.

Currently, you have 3 ways to populate this field:

During account creation via the application.applicant.personal.social_name field.
During account creation via the application.applicant.personal.name field when the field in #1 is not set.
Passing the printed_name field during card creation, updating a card, or when reissuing a card. This takes priority over #1 and #2.

REQUIRED for an UNNUMBERED card (Card created without PIN or PAN that issuer defines at some point in the future.)

namestring

Card alias name for a VIRTUAL card.

This field is REQUIRED to be unique for each VIRTUAL card a customer owns.

No matter what is passed for a PLASTIC card, the value is always PLASTIC.

type'PLASTIC' | 'VIRTUAL' | 'RECURRING' | 'TEMPORARY'

Card type enum:

PLASTIC - Physical card - plastic or metal.
VIRTUAL - Digital card with fixed PAN and dynamic CVV.
TEMPORARY - Virtual card with a fixed PAN and CVV meant for short-term use, typically 24 hours. For more information, refer to Configuring temporary cards in the Cards management guide.
RECURRING - Virtual card with a fixed PAN and CVV originally meant for use with recurring subscriptions. This type is being DEPRECATED and it is recommended you use VIRTUAL instead.

issuing_datestring

Date/time when card was issued in RFC3339 format, i.e., 2019-07-03T17:23:18Z

transaction_limitstring

Optional for virtual cards. Maximum amount allowed per transaction. Set up to the approved limit. If not set, account limit is used.

trackingstring

File sent to embosser tracking ID

contactless_enabledboolean

For physical cards. Is card enabled for contactless transactions?

Default is true.

abu_enabledboolean

This field is DEPRECATED. For more information, refer to the ABU documentation in the Cards overview guide.

When a card is created or reissued, or its account credentials change, Mastercard is notified if this feaure is enabled. Notification updates are sent to Mastercard on a daily basis.

For more information, refer to Mastercard's <a href="https://developer.mastercard.com/product/automatic-billing-updater-abu/" target="_blank">ABU</a> documentation.

Example response

{
  "id": 6741322,
  "status": "NORMAL",
  "stage": "UNBLOCKED",
  "printed_name": "Some person",
  "name": "Vacation card 2",
  "type": "VIRTUAL",
  "issuing_date": "2022-01-04T17:20:15Z",
  "transaction_limit": "100",
  "tracking": "586988",
  "contactless_enabled": true,
  "abu_enabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.