Skip to main content

Contains information about the card used in the transaction.

barcode
string
required

Barcode printed on the card, expressed as numerals.

card_product_token
string
required

Unique identifier of the card product.

created_time
string<date-time>
required

Date and time when the resource was created, in UTC.

expiration
string
required

Expiration date in MMyy format.

expiration_time
string<date-time>
required

Expiration date and time, in UTC.

fulfillment_status
enum<string>
required

Card fulfillment status:

  • ISSUED: Initial state of all newly created/issued cards.
  • ORDERED: Card ordered through the card fulfillment provider.
  • REORDERED: Card reordered through the card fulfillment provider.
  • REJECTED: Card rejected by the card fulfillment provider.
  • SHIPPED: Card shipped by the card fulfillment provider.
  • DELIVERED: Card delivered by the card fulfillment provider.
  • DIGITALLY_PRESENTED: Card digitally presented using the /cards/{token}/showpan endpoint; does not affect the delivery of physical cards.
Available options:
ISSUED,
ORDERED,
REORDERED,
REJECTED,
SHIPPED,
DELIVERED,
DIGITALLY_PRESENTED
last_four
string
required

Last four digits of the card primary account number (PAN).

last_modified_time
string<date-time>
required

Date and time when the resource was last modified, in UTC.

pan
string
required

Primary account number (PAN) of the card.

pin_is_set
boolean
default:false
required

Specifies if the personal identification number (PIN) has been set for the card.

state
enum<string>
required

Indicates the state of the card.

Available options:
ACTIVE,
SUSPENDED,
TERMINATED,
UNSUPPORTED,
UNACTIVATED,
LIMITED
state_reason
string
required

Descriptive reason for why the card is in its current state. For example, "Card activated by cardholder".

token
string
required

Unique identifier of the card.

user_token
string
required

Unique identifier of the cardholder.

3csc
string
account_tokens
string[]

List of account tokens associated with the card

activation_actions
object

Defines actions to execute when the card is activated. The fields in this object are mutually exclusive.

bulk_issuance_token
string

Unique identifier of the bulk card order.

chip_cvv_contactless_number
string
chip_cvv_number
string

Three-digit card verification value (ICVV) stored on the chip of the card.

contactless_exemption_counter
integer<int32>

Running count of the contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the number of contactless transactions that can be performed without issuing an SCA challenge at the card product level.

For more information about strong customer authentication, see <</core-api/card-products, Card Products>>.

contactless_exemption_total_amount
number

Running total of the money spent in contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the total amount that can be spent in contactless transactions without issuing an SCA challenge at the card product level.

For more information about strong customer authentication, see <</core-api/card-products, Card Products>>.

contactless_exemption_transaction_currency
string

Indicates the currency type of the transaction.

cvv_number
string

Three-digit card verification value (CVV2 or CVC2) printed on the card.

expedite
boolean
default:false

A value of true indicates that you requested expedited processing of the card from your card fulfillment provider.

fulfillment
object

Determines physical characteristics of a card and shipment information.

instrument_type
enum<string>

Instrument type of the card:

  • PHYSICAL_MSR: A physical card with a magnetic stripe. This is the default physical card type.
  • PHYSICAL_ICC: A physical card with an integrated circuit, or "chip."
  • PHYSICAL_CONTACTLESS: A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface.
  • PHYSICAL_COMBO: A physical card with a chip that also supports contactless payments.
  • VIRTUAL_PAN: A virtual card with a primary account number (PAN).
Available options:
PHYSICAL_MSR,
PHYSICAL_ICC,
PHYSICAL_CONTACTLESS,
PHYSICAL_COMBO,
VIRTUAL_PAN
issuer_country
string

ISO 3166 numeric issuer country code. On the transaction payload, sourced per network (Mastercard: DE 20 PAN country code; Visa: card product BIN_ISSUE_COUNTRY config). Present only when resolvable.

metadata
object

Associates customer-provided metadata with the card.

new_pan_from_card_token
string

Reissues the specified card (known as the "source" card) with a new primary account number (PAN).

reissue_pan_from_card_token
string

Reissues the specified card (known as the "source" card).

translate_pin_from_card_token
string

Copies the personal identification number (PIN) from the specified source card to the newly created card.

user
object

Contains information about a cardholder.