Card status

Update card status

Change a card's status. For more information, Refer to the Card lifecycle and statuses guide.

This endpoint generates a Card updated event.

put/wallet/v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/status

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/wallet/v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/status
  • Auth
    HTTP bearer

Path parameters

cardIdstring required

Pismo card ID

accountIdinteger required

Pismo account ID

customerIdstring required

Customer ID

Request body

statusstring

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

Example request

{
  "status": "NORMAL"
}

Response

Card information

idinteger

Pismo card ID

hashstring

Encrypted Primary Account Number (PAN). This field does not exist until the card PCI data is asynchronously created.

last_4_digitsstring

Last four Primary Account Number (PAN) digits. This field does not exist until the card PCI data is asynchronously created.

first_4_digitsstring

First 4 PAN digits. This field is DEPRECATED and it is recommended you use the bin field instead.

brandstring

Card network, i.e., Visa, Mastercard, ELO, RuPay, Private, GPN

number_of_transactionsinteger

Maximum transactions allowed

binstring

Bank Identification Number (BIN). A 6 or 8 digit number identitying the card network, issuer, and product.

atcstring

Application Transaction Counter (ATC). The chip card application maintains the ATC as a counter that the chip increments. It provides a reference for each transaction. A duplicate ATC, a decrease in ATC, or a large jump in ATC values may indicate data copying or other fraud.

Though the ATC is a string, it takes the form of an array of integers containing up to 1000 numbers showing the counter's sequence.

For more information on how Pismo uses the ATC, refer to the Application Transaction Counter guide.

statusstring

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

previous_statusstring

Previous card status.

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

issuing_datestring

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

expiration_datestring

Card expiration date (format = yymm). If passed, the card expiration date is not calculated using the "Card expiration (# of months)" program parameter.

printed_namestring

Printed/embossed card name.

Currently, you have 3 ways to populate this field:

  1. During account creation via the application.applicant.personal.social_name field.
  2. During account creation via the application.applicant.personal.name field when the field in #1 is not set.
  3. 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.)

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.

trackinginteger

File sent to embosser tracking ID

track_numberinteger

Sequential counter incremented every time card is reissued.

migration_idstring

Migration ID (if card migrated to Pismo).

transaction_limitstring

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

password_triesinteger

Number of times the password was tried

embossing_custom_fieldstring

For physical cards. Additional information for embossing company. For example: tracking number or whether the card should be plastic or metal.

You can use this field for any embossing needs specific to your business. Whatever is sent must be agreed upon with the embosser—what to send, what values to send, what format to send, what size to send for each value, and so on.

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

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.

reissued_card_idinteger

Last issued card ID

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.
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.

template_idstring

Template ID. Templates are used to implement the BIN override feature. For more information, refer to the BIN override guide.

valid_untilstring

Card validation date in UTC time (format:yyyy-MM-ddThh:mm:ssZ). For TEMPORARY virtual cards, which have a limited time frame, typically 24 hours (default), or according to the program parameter for this, which is why the date/time here is more granular than expiration_date.

For more information, refer to Configuring temporary cards.

bulk_idstring

Noname bulk/batch ID

external_idstring

Client internal tracking ID

mode'CREDIT' | 'DEBIT' | 'COMBO' | 'MULTIPLE'

Mode enum: CREDIT - Single credit card DEBIT - Single debit card COMBO - Card has both a credit and debit mode, meaning it is associated with both a credit and debit program and account. MULTIPLE - Combination card created with the DEPRECATED Create combo card endpoint.

For more information, refer to the mode documentation in the Card management guide.

dual_message_debitboolean

For Mastercard - if card is DMC, where the debit has authorization and confirmation at different times, base I and base II, respectively. Unlike Mastercard's Maestro debit, where authorization and confirmation take place at the same time (base I).

Default is false.

Example response

{
  "program": {
    "id": "8519"
  },
  "account": {
    "id": "102378693"
  },
  "customer": {
    "id": "102377856"
  },
  "org": {
    "id": "TN-f878e4a1-2879-48ba-be16-821e73ac98db"
  },
  "id": 6741322,
  "hash": "WEPvOQuZvjfYEd0iBmr43bhWyOsylIsW95ebYrLD89App2iEq9IizP+8w73pxKQ4mI47EdhzYHF9RfXjrBOyug==",
  "last_4_digits": "3598",
  "first_4_digits": "null",
  "status": "PENDING",
  "stage": "UNBLOCKED",
  "issuing_date": "2022-01-04T17:20:15Z",
  "expiration_date": "2027-01-04T00:00:00Z",
  "printed_name": "Some person",
  "name": "Vacation card 2",
  "tracking": 4859,
  "track_number": 1,
  "transaction_limit": "100",
  "embossing_custom_field": "Emboss it, emboss it good",
  "contactless_enabled": true,
  "abu_enabled": true,
  "reissued_card_id": 38474,
  "type": "VIRTUAL",
  "metadata": {
    "my-custom-key": "my-custom-value"
  },
  "template_id": "null",
  "valid_until": "null",
  "bulk_id": "null",
  "external_id": "null",
  "mode": "CREDIT",
  "dual_message_debit": true
}

Changes

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