Card Products
The card products resource represents the behavior and functionality of one or more cards (either physical or virtual). For example, attributes of the card product determine whether the associated cards can be used at an ATM and/or online and whether they are currently enabled. For physical cards, the card product determines color and other printing specifications for when the cards are manufactured and personalized. You can optionally associate authorization controls and/or velocity controls with card products to restrict where and how associated cards are used.
If your program is Managed by Marqeta, then Marqeta will create the card products for your production environment.
Some attributes of the cardproduct object can also be defined in an associated bulkissuance or card object.
If you define one of these attributes in more than one object, the Marqeta platform applies an order of precedence to determine which attribute to use at fulfillment time.
The order of precedence is as follows:
-
card -
bulkissuance -
cardproduct
Defining an attribute in an object with higher precedence does not overwrite the same attribute in a lower-precedence object; the Marqeta platform ignores these lower-precedence attributes.
For more information on cards, see About Cards.
Create card product
Copy section link
Action: POST
Endpoint: /cardproducts
Use this endpoint to create a card product.
The card product request contains a set of fields that provide basic information about the card product, such as name, active status, and start and end dates.
Configuration information is contained in the config object, which contains sub-elements whose fields control the features and behavior of the card product.
The elements are referred to collectively as the card product "configuration," and as such are contained in a config object.
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Indicates whether the card product is active. NOTE: This field has no effect on the ability to create cards from this card product.
Use the Allowable Values:
Default value: |
config
object
|
Defines the characteristics of the card product. Configurations are conditionally required based on program setup. Allowable Values:
|
config.card_life_cycle
object
|
Defines characteristics of the lifecycle of cards of this card product type. Allowable Values:
|
config.card_life_cycle.activate_upon_issue
boolean
|
A value of Allowable Values:
Default value: |
config.card_life_cycle.card_service_code
integer
|
Sequence of three digits that defines various services, differentiates card usage in international or domestic interchange, designates personal identification number (PIN) and authorization requirements, and identifies card restrictions. The following values are commonly used: First digit
Second digit
Third digit
Allowable Values: 100 - 999 Default value: |
config.card_life_cycle.expiration_offset
object
|
Specifies the length of time after the date of issue for which cards of this card product type are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset
object
|
Specifies the minimum length of time after the date of issue for which the cards are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.unit
string
|
Specifies the time unit of the Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
config.card_life_cycle.expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.update_expiration_upon_activation
boolean
|
Normally, the Allowable Values:
Default value: |
config.clearing_and_settlement
object
|
Specifies the destination for overdraft funds. Allowable Values:
|
config.clearing_and_settlement.overdraft_destination
string
|
Specifies the destination for overdraft funds. This field does not apply if JIT Funding is enabled. Allowable Values:
Default value: |
config.digital_wallet_tokenization
object
|
Controls characteristics related to digital wallets. Allowable Values:
|
config.digital_wallet_tokenization.card_art_id
string
|
Specifies the digital wallet card art identifier for the card product. Digital wallets display the card art after the initial token has been provisioned and activated. Digital wallet card art is updated for all wallets automatically whenever a tokenized card is reissued or replaced.
If this field is left blank, your card product inherits the card art assigned to the account BIN range. Allowable Values: Valid identifiers are defined by Visa or Mastercard and vary by program:
|
config.digital_wallet_tokenization.provisioning_controls
object
|
Controls the provisioning of digital wallets. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.in_app_provisioning
object
|
Controls the provisioning of digital wallets by a Marqeta customer’s mobile application. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.manual_entry
object
|
Controls the provisioning of digital wallets by manual entry, in which the cardholder manually enters the card’s primary account number (PAN), card verification value (CVV2), and expiration date. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.wallet_provider_card_on_file
object
|
Controls the provisioning of digital wallets where the digital wallet provider already has the card on file. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.web_push_provisioning
object
|
Specifies the digital wallet card art and program configuration identifiers at the card product level for Web Push Provisioning. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.dwt_use_card_status_during_auth
boolean
|
If Allowable Values:
Default value: |
config.fulfillment
object
|
Determines physical characteristics of a card, along with its bulk shipment information. Allowable Values:
|
config.fulfillment.all_zero_card_security_code
boolean
|
If Allowable Values:
Default value: |
config.fulfillment.allow_card_creation
boolean
|
Controls the ability to create cards from this card product; NOTE: The card product’s Allowable Values:
Default value: |
config.fulfillment.bin_prefix
string
|
Prefix of the bank identification number. Allowable Values: A six-digit number for the sandbox environment; a six- to nine-digit number is expected in production environments (see note below). Default value: NOTE: In the sandbox environment or when testing against OpenAPI (Swagger), this field must be set to |
config.fulfillment.bulk_ship
boolean
|
Enables bulk ordering of cards of this card product type using the Allowable Values:
Default value: |
config.fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card product. Allowable Values: Valid |
config.fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
config.fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
config.fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
config.fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
config.fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
config.fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.enable_offline_pin
boolean
|
Enables offline personal identification number (PIN) verification for Europay Mastercard and Visa (EMV, or "chip-and-PIN") card payments. Allowable Values:
Default value: |
config.fulfillment.fulfillment_provider
string
|
Specifies the fulfillment provider. NOTE: Expedited processing is available for cards that are fulfilled by Perfect Plastic Printing, IDEMIA, and Arroweye Solutions.
You can expedite an order’s processing by using the Allowable Values:
Default value: |
config.fulfillment.package_id
string
|
Card fulfillment provider’s package ID. Allowable Values: 1–50 chars |
config.fulfillment.pan_length
string
|
Specifies the length of the primary account number (PAN). Allowable Values: Default value: |
config.fulfillment.payment_instrument
string
|
Specifies the physical form cards of this card product type will take. Allowable Values:
Default value: |
config.fulfillment.shipping
object
|
Specifies shipping details for the order. Allowable Values:
|
config.fulfillment.shipping.care_of_line
string
|
Adds the specified value as a care of (C/O) line to the mailing carrier. NOTE: This field can be specified on cards, card products, and bulk card orders. If you specify this field at multiple levels, the order of precedence is: card, bulk card order, card product. Allowable Values: 255 char max |
config.fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
config.fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. In order to generate cards, a valid shipping address must be provided by one of these:
The order of precedence from highest to lowest is card, user, card product.
To be valid, an address must have the Allowable Values: Valid |
config.fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.recipient_address.city
string
|
City of the address. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
config.fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
config.fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.recipient_address.state
string
|
State of the address. Allowable Values: 32 char max |
config.fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. Allowable Values:
|
config.fulfillment.shipping.return_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.return_address.city
string
|
City of the address. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
config.fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
config.fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.return_address.state
string
|
State of the address. Allowable Values: 32 char max |
config.fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
config.fulfillment.uppercase_name_lines
boolean
|
A value of Allowable Values:
Default value: |
config.jit_funding
object
|
Governs the behavior of JIT Funding. Allowable Values:
|
config.jit_funding.paymentcard_funding_source
object
|
Enables and configures a payment card funding source. Allowable Values: Valid |
config.jit_funding.paymentcard_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the payment card funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.paymentcard_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal. Allowable Values:
|
config.jit_funding.program_funding_source
object
|
Enables and configures a program funding source. Allowable Values: Valid |
config.jit_funding.program_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.program_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
config.jit_funding.program_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
Allowable Values:
|
config.jit_funding.programgateway_funding_source
object
|
Enables and configures a program gateway funding source. Allowable Values: Valid |
config.jit_funding.programgateway_funding_source.always_fund
boolean
|
If set to Allowable Values:
Default value: |
config.jit_funding.programgateway_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program gateway funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.programgateway_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
config.jit_funding.programgateway_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
In most cases, you should set the value to Allowable Values:
|
config.poi
object
|
Governs the point of interaction. Allowable Values:
|
config.poi.atm
boolean
|
If set to Allowable Values:
Default value: |
config.poi.ecommerce
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other
object
|
Allows for configuration of points of interaction other than ecommerce or ATMs, such as points of sale (POS). Allowable Values:
|
config.poi.other.allow
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other.card_presence_required
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other.cardholder_presence_required
boolean
|
If set to Allowable Values:
Default value: |
config.selective_auth
object
|
Contains information about authorization decisions. Allowable Values:
|
config.selective_auth.dmd_location_sensitivity
integer
|
Determines what type of merchant information is required for a match (authorization).
Not relevant if
Allowable Values:
Default value: |
config.selective_auth.enable_regex_search_chain
boolean
|
Set to Allowable Values:
Default value: |
config.selective_auth.sa_mode
integer
|
Specifies the selective authorization mode.
Selective authorization applies to transactions that are limited to specific merchants.
Matching requirements for authorization are set by the Allowable Values:
Default value: |
config.special
object
|
Contains information about merchant onboarding. Allowable Values:
|
config.special.merchant_on_boarding
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls
object
|
Controls transactional characteristics of card usage. Allowable Values:
|
config.transaction_controls.accepted_countries_token
string
|
Set to Set to Users with the Admin role can create and update additional lists of accepted countries for transactions at the Allowable Values:
Default value: |
config.transaction_controls.address_verification
object
|
Contains configuration options for AVS. Allowable Values: Valid |
config.transaction_controls.address_verification.auth_messages
object
|
Contains verification options for authorization messages. These messages pertain to actual purchases and are for amounts greater than $0. Allowable Values: One or more verification options |
config.transaction_controls.address_verification.av_messages
object
|
Contains verification options for account verification messages. These are $0 messages typically used to store cards on file at a merchant. Allowable Values: One or more verification options |
config.transaction_controls.allow_chip_fallback
boolean
|
Indicates whether to allow transactions where a Europay Mastercard and Visa (EMV) chip-enabled card was processed using the magstripe as fallback. Allowable Values:
Default value: |
config.transaction_controls.allow_first_pin_set_via_financial_transaction
boolean
|
WARNING: This field is deprecated and will be unsupported in a future release. Allows cardholders to define a personal identification number (PIN) as they complete their first PIN-debit transaction. Allowable Values:
Default value: |
config.transaction_controls.allow_gpa_auth
boolean
|
If set to NOTE: For most programs, this field should be set to Allowable Values:
Default value: |
config.transaction_controls.allow_mcc_group_authorization_controls
boolean
|
The MCC group NOTE: Partial authorizations are disallowed if this field is set to Allowable Values:
Default value: |
config.transaction_controls.allow_network_load
boolean
|
Indicates whether card network loads are allowed.
The associated card’s state must be Allowable Values:
Default value: |
config.transaction_controls.allow_network_load_card_activation
boolean
|
Indicates whether card network loads are allowed.
Sets the associated card’s state to Allowable Values:
Default value: |
config.transaction_controls.allow_quasi_cash
boolean
|
Indicates whether quasi-cash transactions are allowed. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values:
Default value: |
config.transaction_controls.always_require_icc
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls.always_require_pin
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls.enable_partial_auth_approval
boolean
|
Set to When this setting is Allowable Values:
Default value: |
config.transaction_controls.ignore_card_suspended_state
boolean
|
Allows transactions to be approved even if the card’s Allowable Values:
Default value: |
config.transaction_controls.notification_language
string
|
Specifies the language for 3D Secure and digital wallet token notifications sent to cardholders under this card program. You can send notifications to your cardholders in the following languages:
By default, notifications are sent in English. To specify the language for OTP notifications at the user level, see Users. Languages set at the user level take precedence over the language set at the card product level. Allowable Values:
If you leave this field blank, cardholders receive notifications in English. |
config.transaction_controls.quasi_cash_exempt_merchant_group_token
string
|
The token of the merchant group that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. You can specify a merchant group token in addition to whatever merchant identifiers you listed in the Allowable Values: 1–36 chars Valid merchant group token. |
config.transaction_controls.quasi_cash_exempt_mids
string
|
Comma-separated list of merchant identifiers that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values: 255 char max For example: |
config.transaction_controls.require_card_not_present_card_security_code
boolean
|
A value of Allowable Values:
Default value: |
config.transaction_controls.strong_customer_authentication_limits
object
|
Contains information about Strong Customer Authentication (SCA) behavior for contactless point-of-sale (POS) and low-value payment (LVP) e-commerce transactions. Allowable Values:
|
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single contactless point-of-sale (POS) transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_count_limit
integer
|
Specifies the number of contactless POS transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: Any integer, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_currency
string
|
Specifies the currency type for contactless POS transactions. This field is required if either the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. For example, if you set the value of this field to If you leave this field blank, the cumulative amount spent in LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. If you leave this field blank, the amount of any single LVP e-commerce transaction performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_count_limit
integer
|
Specifies the number of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. If you leave this field blank, the total number of LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: An integer, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_currency
string
|
Specifies the currency type for LVP e-commerce transaction limits. This field is required if any one of the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_tra_exemption_amount_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction with transaction risk analysis (TRA) exemption sent by the merchant or acquirer.
If the transaction amount exceeds the specified limit, then the transaction is either approved or it receives a strong customer authentication (SCA) challenge based on Allowable Values: decimal Format: Default value: |
end_date
date
|
End date of the range over which the card product can be active. Allowable Values: Format: yyyy-mm-DD |
name
string
|
Name of the card product. Marqeta recommends that you use a unique string. Allowable Values: 1–40 chars |
start_date
date
|
Date when the card product becomes active.
If the start date has passed and the card is set to Allowable Values: Format: yyyy-mm-DD |
token
string
|
Unique identifier of the card product. If you do not include a token, the system will generate one automatically. This token is required in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Indicates whether the card product is active. This field is returned if it exists in the resource. Allowable Values:
Default value: |
config
object
|
Defines the characteristics of the card product. Configurations are conditionally returned based on program setup. Allowable Values:
|
config.card_life_cycle
object
|
Defines characteristics of the lifecycle of cards of this card product type. Allowable Values:
|
config.card_life_cycle.activate_upon_issue
boolean
|
A value of Allowable Values:
Default value: |
config.card_life_cycle.card_service_code
integer
|
Sequence of three digits that defines various services, differentiates card usage in international or domestic interchange, designates personal identification number (PIN) and authorization requirements, and identifies card restrictions. The following values are commonly used: First digit
Second digit
Third digit
Allowable Values: 100 - 999 Default value: |
config.card_life_cycle.expiration_offset
object
|
Specifies the length of time after the date of issue for which cards of this card product type are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset
object
|
Specifies the minimum length of time after the date of issue for which the cards are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.unit
string
|
Specifies the time unit of the Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
config.card_life_cycle.expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.update_expiration_upon_activation
boolean
|
Normally, the Allowable Values:
Default value: |
config.clearing_and_settlement
object
|
Specifies the destination for overdraft funds. Allowable Values:
|
config.clearing_and_settlement.overdraft_destination
string
|
Specifies the destination for overdraft funds. This field does not apply if JIT Funding is enabled. Allowable Values:
Default value: |
config.digital_wallet_tokenization
object
|
Controls characteristics related to digital wallets. Allowable Values:
|
config.digital_wallet_tokenization.card_art_id
string
|
Specifies the digital wallet card art identifier for the card product. Digital wallets display the card art after the initial token has been provisioned and activated. Digital wallet card art is updated for all wallets automatically whenever a tokenized card is reissued or replaced.
If this field is left blank, your card product inherits the card art assigned to the account BIN range. Allowable Values: Valid identifiers are defined by Visa or Mastercard and vary by program:
|
config.digital_wallet_tokenization.provisioning_controls
object
|
Controls the provisioning of digital wallets. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.in_app_provisioning
object
|
Controls the provisioning of digital wallets by a Marqeta customer’s mobile application. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.manual_entry
object
|
Controls the provisioning of digital wallets by manual entry, in which the cardholder manually enters the card’s primary account number (PAN), card verification value (CVV2), and expiration date. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.wallet_provider_card_on_file
object
|
Controls the provisioning of digital wallets where the digital wallet provider already has the card on file. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.web_push_provisioning
object
|
Specifies the digital wallet card art and program configuration identifiers at the card product level for Web Push Provisioning. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.dwt_use_card_status_during_auth
boolean
|
If Allowable Values:
Default value: |
config.fulfillment
object
|
Determines physical characteristics of a card, along with its bulk shipment information. Allowable Values:
|
config.fulfillment.all_zero_card_security_code
boolean
|
If Allowable Values:
Default value: |
config.fulfillment.allow_card_creation
boolean
|
Controls the ability to create cards from this card product; NOTE: The card product’s Allowable Values:
Default value: |
config.fulfillment.bin_prefix
string
|
Prefix of the bank identification number. Allowable Values: A six-digit number for the sandbox environment; a six- to nine-digit number is expected in production environments (see note below). Default value: NOTE: In the sandbox environment or when testing against OpenAPI (Swagger), this field must be set to |
config.fulfillment.bulk_ship
boolean
|
Enables bulk ordering of cards of this card product type using the Allowable Values:
Default value: |
config.fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card product. Allowable Values: Valid |
config.fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
config.fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
config.fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
config.fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
config.fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
config.fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.enable_offline_pin
boolean
|
Enables offline personal identification number (PIN) verification for Europay Mastercard and Visa (EMV, or "chip-and-PIN") card payments. Allowable Values:
Default value: |
config.fulfillment.fulfillment_provider
string
|
Specifies the fulfillment provider. NOTE: Expedited processing is available for cards that are fulfilled by Perfect Plastic Printing, IDEMIA, and Arroweye Solutions.
You can expedite an order’s processing by using the Allowable Values:
Default value: |
config.fulfillment.package_id
string
|
Card fulfillment provider’s package ID. Allowable Values: 1–50 chars |
config.fulfillment.pan_length
string
|
Specifies the length of the primary account number (PAN). Allowable Values: Default value: |
config.fulfillment.payment_instrument
string
|
Specifies the physical form cards of this card product type will take. Allowable Values:
Default value: |
config.fulfillment.shipping
object
|
Specifies shipping details for the order. Allowable Values:
|
config.fulfillment.shipping.care_of_line
string
|
Adds the specified value as a care of (C/O) line to the mailing carrier. NOTE: This field can be specified on cards, card products, and bulk card orders. If you specify this field at multiple levels, the order of precedence is: card, bulk card order, card product. Allowable Values: 255 char max |
config.fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
config.fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. In order to generate cards, a valid shipping address must be provided by one of these:
The order of precedence from highest to lowest is card, user, card product.
To be valid, an address must have the Allowable Values: Valid |
config.fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.recipient_address.city
string
|
City of the address. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
config.fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
config.fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.recipient_address.state
string
|
State of the address. Allowable Values: 32 char max |
config.fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. Allowable Values:
|
config.fulfillment.shipping.return_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
config.fulfillment.shipping.return_address.city
string
|
City of the address. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
config.fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
config.fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
config.fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
config.fulfillment.shipping.return_address.state
string
|
State of the address. Allowable Values: 32 char max |
config.fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
config.fulfillment.uppercase_name_lines
boolean
|
A value of Allowable Values:
Default value: |
config.jit_funding
object
|
Governs the behavior of JIT Funding. Allowable Values:
|
config.jit_funding.paymentcard_funding_source
object
|
Enables and configures a payment card funding source. Allowable Values: Valid |
config.jit_funding.paymentcard_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the payment card funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.paymentcard_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal. Allowable Values:
|
config.jit_funding.program_funding_source
object
|
Enables and configures a program funding source. Allowable Values: Valid |
config.jit_funding.program_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.program_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
config.jit_funding.program_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
Allowable Values:
|
config.jit_funding.programgateway_funding_source
object
|
Enables and configures a program gateway funding source. Allowable Values: Valid |
config.jit_funding.programgateway_funding_source.always_fund
boolean
|
If set to Allowable Values:
Default value: |
config.jit_funding.programgateway_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program gateway funding source.
A value of Allowable Values:
Default value: |
config.jit_funding.programgateway_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
config.jit_funding.programgateway_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
In most cases, you should set the value to Allowable Values:
|
config.poi
object
|
Governs the point of interaction. Allowable Values:
|
config.poi.atm
boolean
|
If set to Allowable Values:
Default value: |
config.poi.ecommerce
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other
object
|
Allows for configuration of points of interaction other than ecommerce or ATMs, such as points of sale (POS). Allowable Values:
|
config.poi.other.allow
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other.card_presence_required
boolean
|
If set to Allowable Values:
Default value: |
config.poi.other.cardholder_presence_required
boolean
|
If set to Allowable Values:
Default value: |
config.selective_auth
object
|
Contains information about authorization decisions. Allowable Values:
|
config.selective_auth.dmd_location_sensitivity
integer
|
Determines what type of merchant information is required for a match (authorization).
Not relevant if
Allowable Values:
Default value: |
config.selective_auth.enable_regex_search_chain
boolean
|
Set to Allowable Values:
Default value: |
config.selective_auth.sa_mode
integer
|
Specifies the selective authorization mode.
Selective authorization applies to transactions that are limited to specific merchants.
Matching requirements for authorization are set by the Allowable Values:
Default value: |
config.special
object
|
Contains information about merchant onboarding. Allowable Values:
|
config.special.merchant_on_boarding
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls
object
|
Controls transactional characteristics of card usage. Allowable Values:
|
config.transaction_controls.accepted_countries_token
string
|
Set to Set to Users with the Admin role can create and update additional lists of accepted countries for transactions at the Allowable Values:
Default value: |
config.transaction_controls.address_verification
object
|
Contains configuration options for AVS. Allowable Values: Valid |
config.transaction_controls.address_verification.auth_messages
object
|
Contains verification options for authorization messages. These messages pertain to actual purchases and are for amounts greater than $0. Allowable Values: One or more verification options |
config.transaction_controls.address_verification.av_messages
object
|
Contains verification options for account verification messages. These are $0 messages typically used to store cards on file at a merchant. Allowable Values: One or more verification options |
config.transaction_controls.allow_chip_fallback
boolean
|
Indicates whether to allow transactions where a Europay Mastercard and Visa (EMV) chip-enabled card was processed using the magstripe as fallback. Allowable Values:
Default value: |
config.transaction_controls.allow_first_pin_set_via_financial_transaction
boolean
|
WARNING: This field is deprecated and will be unsupported in a future release. Allows cardholders to define a personal identification number (PIN) as they complete their first PIN-debit transaction. Allowable Values:
Default value: |
config.transaction_controls.allow_gpa_auth
boolean
|
If set to NOTE: For most programs, this field should be set to Allowable Values:
Default value: |
config.transaction_controls.allow_mcc_group_authorization_controls
boolean
|
The MCC group NOTE: Partial authorizations are disallowed if this field is set to Allowable Values:
Default value: |
config.transaction_controls.allow_network_load
boolean
|
Indicates whether card network loads are allowed.
The associated card’s state must be Allowable Values:
Default value: |
config.transaction_controls.allow_network_load_card_activation
boolean
|
Indicates whether card network loads are allowed.
Sets the associated card’s state to Allowable Values:
Default value: |
config.transaction_controls.allow_quasi_cash
boolean
|
Indicates whether quasi-cash transactions are allowed. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values:
Default value: |
config.transaction_controls.always_require_icc
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls.always_require_pin
boolean
|
If set to Allowable Values:
Default value: |
config.transaction_controls.enable_partial_auth_approval
boolean
|
Set to When this setting is Allowable Values:
Default value: |
config.transaction_controls.ignore_card_suspended_state
boolean
|
Allows transactions to be approved even if the card’s Allowable Values:
Default value: |
config.transaction_controls.notification_language
string
|
Specifies the language for 3D Secure and digital wallet token notifications sent to cardholders under this card program. You can send notifications to your cardholders in the following languages:
By default, notifications are sent in English. To specify the language for OTP notifications at the user level, see Users. Languages set at the user level take precedence over the language set at the card product level. Allowable Values:
If you leave this field blank, cardholders receive notifications in English. |
config.transaction_controls.quasi_cash_exempt_merchant_group_token
string
|
The token of the merchant group that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. You can specify a merchant group token in addition to whatever merchant identifiers you listed in the Allowable Values: 1–36 chars Valid merchant group token. |
config.transaction_controls.quasi_cash_exempt_mids
string
|
Comma-separated list of merchant identifiers that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values: 255 char max For example: |
config.transaction_controls.require_card_not_present_card_security_code
boolean
|
A value of Allowable Values:
Default value: |
config.transaction_controls.strong_customer_authentication_limits
object
|
Contains information about Strong Customer Authentication (SCA) behavior for contactless point-of-sale (POS) and low-value payment (LVP) e-commerce transactions. Allowable Values:
|
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single contactless point-of-sale (POS) transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_count_limit
integer
|
Specifies the number of contactless POS transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: Any integer, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_currency
string
|
Specifies the currency type for contactless POS transactions. This field is required if either the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. For example, if you set the value of this field to If you leave this field blank, the cumulative amount spent in LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. If you leave this field blank, the amount of any single LVP e-commerce transaction performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_count_limit
integer
|
Specifies the number of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. If you leave this field blank, the total number of LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: An integer, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_currency
string
|
Specifies the currency type for LVP e-commerce transaction limits. This field is required if any one of the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
config.transaction_controls.strong_customer_authentication_limits.sca_tra_exemption_amount_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction with transaction risk analysis (TRA) exemption sent by the merchant or acquirer.
If the transaction amount exceeds the specified limit, then the transaction is either approved or it receives a strong customer authentication (SCA) challenge based on Allowable Values: decimal Format: Default value: |
created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: datetime Format: |
end_date
date
|
End date of the range over which the card product can be active. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-mm-DD |
last_modified_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: |
name
string
|
Name of the card product. Allowable Values: 1–40 chars |
start_date
date
|
Date when the card product becomes active. Allowable Values: Format: yyyy-mm-DD |
token
string
|
Unique identifier of the card product. Allowable Values: 1–36 chars If you did not include a token in your request, the system returns an automatically generated token in the response. |
List card products
Copy section link
Action: GET
Endpoint: /cardproducts
Use this endpoint to list existing card products.
This endpoint supports pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources to retrieve. Count can be between 1 - 10 items. Allowable Values: 1-10 Default value: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
Default value: |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
data
array of objects
|
Array of card product objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more card product objects |
data[].active
boolean
|
Indicates whether the card product is active. This field is returned if it exists in the resource. Allowable Values:
Default value: |
data[].config
object
|
Defines the characteristics of the card product. Configurations are conditionally returned based on program setup. Allowable Values:
|
data[].config.card_life_cycle
object
|
Defines characteristics of the lifecycle of cards of this card product type. Allowable Values:
|
data[].config.card_life_cycle.activate_upon_issue
boolean
|
A value of Allowable Values:
Default value: |
data[].config.card_life_cycle.card_service_code
integer
|
Sequence of three digits that defines various services, differentiates card usage in international or domestic interchange, designates personal identification number (PIN) and authorization requirements, and identifies card restrictions. The following values are commonly used: First digit
Second digit
Third digit
Allowable Values: 100 - 999 Default value: |
data[].config.card_life_cycle.expiration_offset
object
|
Specifies the length of time after the date of issue for which cards of this card product type are valid. Allowable Values:
|
data[].config.card_life_cycle.expiration_offset.min_offset
object
|
Specifies the minimum length of time after the date of issue for which the cards are valid. Allowable Values:
|
data[].config.card_life_cycle.expiration_offset.min_offset.unit
string
|
Specifies the time unit of the Allowable Values:
|
data[].config.card_life_cycle.expiration_offset.min_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
data[].config.card_life_cycle.expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
data[].config.card_life_cycle.expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
data[].config.card_life_cycle.update_expiration_upon_activation
boolean
|
Normally, the Allowable Values:
Default value: |
data[].config.clearing_and_settlement
object
|
Specifies the destination for overdraft funds. Allowable Values:
|
data[].config.clearing_and_settlement.overdraft_destination
string
|
Specifies the destination for overdraft funds. This field does not apply if JIT Funding is enabled. Allowable Values:
Default value: |
data[].config.digital_wallet_tokenization
object
|
Controls characteristics related to digital wallets. Allowable Values:
|
data[].config.digital_wallet_tokenization.card_art_id
string
|
Specifies the digital wallet card art identifier for the card product. Digital wallets display the card art after the initial token has been provisioned and activated. Digital wallet card art is updated for all wallets automatically whenever a tokenized card is reissued or replaced.
If this field is left blank, your card product inherits the card art assigned to the account BIN range. Allowable Values: Valid identifiers are defined by Visa or Mastercard and vary by program:
|
data[].config.digital_wallet_tokenization.provisioning_controls
object
|
Controls the provisioning of digital wallets. Allowable Values: Valid |
data[].config.digital_wallet_tokenization.provisioning_controls.in_app_provisioning
object
|
Controls the provisioning of digital wallets by a Marqeta customer’s mobile application. Allowable Values: Valid |
data[].config.digital_wallet_tokenization.provisioning_controls.manual_entry
object
|
Controls the provisioning of digital wallets by manual entry, in which the cardholder manually enters the card’s primary account number (PAN), card verification value (CVV2), and expiration date. Allowable Values: Valid |
data[].config.digital_wallet_tokenization.provisioning_controls.wallet_provider_card_on_file
object
|
Controls the provisioning of digital wallets where the digital wallet provider already has the card on file. Allowable Values: Valid |
data[].config.digital_wallet_tokenization.provisioning_controls.web_push_provisioning
object
|
Specifies the digital wallet card art and program configuration identifiers at the card product level for Web Push Provisioning. Allowable Values: Valid |
data[].config.digital_wallet_tokenization.provisioning_controls.dwt_use_card_status_during_auth
boolean
|
If Allowable Values:
Default value: |
data[].config.fulfillment
object
|
Determines physical characteristics of a card, along with its bulk shipment information. Allowable Values:
|
data[].config.fulfillment.all_zero_card_security_code
boolean
|
If Allowable Values:
Default value: |
data[].config.fulfillment.allow_card_creation
boolean
|
Controls the ability to create cards from this card product; NOTE: The card product’s Allowable Values:
Default value: |
data[].config.fulfillment.bin_prefix
string
|
Prefix of the bank identification number. Allowable Values: A six-digit number for the sandbox environment; a six- to nine-digit number is expected in production environments (see note below). Default value: NOTE: In the sandbox environment or when testing against OpenAPI (Swagger), this field must be set to |
data[].config.fulfillment.bulk_ship
boolean
|
Enables bulk ordering of cards of this card product type using the Allowable Values:
Default value: |
data[].config.fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card product. Allowable Values: Valid |
data[].config.fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
data[].config.fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
data[].config.fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
data[].config.fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
data[].config.fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
data[].config.fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
data[].config.fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
data[].config.fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
data[].config.fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values:
|
data[].config.fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
data[].config.fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].config.fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
data[].config.fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values:
|
data[].config.fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
data[].config.fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].config.fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
data[].config.fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].config.fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
data[].config.fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].config.fulfillment.enable_offline_pin
boolean
|
Enables offline personal identification number (PIN) verification for Europay Mastercard and Visa (EMV, or "chip-and-PIN") card payments. Allowable Values:
Default value: |
data[].config.fulfillment.fulfillment_provider
string
|
Specifies the fulfillment provider. NOTE: Expedited processing is available for cards that are fulfilled by Perfect Plastic Printing, IDEMIA, and Arroweye Solutions.
You can expedite an order’s processing by using the Allowable Values:
Default value: |
data[].config.fulfillment.package_id
string
|
Card fulfillment provider’s package ID. Allowable Values: 1–50 chars |
data[].config.fulfillment.pan_length
string
|
Specifies the length of the primary account number (PAN). Allowable Values: Default value: |
data[].config.fulfillment.payment_instrument
string
|
Specifies the physical form cards of this card product type will take. Allowable Values:
Default value: |
data[].config.fulfillment.shipping
object
|
Specifies shipping details for the order. Allowable Values:
|
data[].config.fulfillment.shipping.care_of_line
string
|
Adds the specified value as a care of (C/O) line to the mailing carrier. NOTE: This field can be specified on cards, card products, and bulk card orders. If you specify this field at multiple levels, the order of precedence is: card, bulk card order, card product. Allowable Values: 255 char max |
data[].config.fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
data[].config.fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. In order to generate cards, a valid shipping address must be provided by one of these:
The order of precedence from highest to lowest is card, user, card product.
To be valid, an address must have the Allowable Values: Valid |
data[].config.fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].config.fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].config.fulfillment.shipping.recipient_address.city
string
|
City of the address. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.recipient_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
data[].config.fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
data[].config.fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
data[].config.fulfillment.shipping.recipient_address.state
string
|
State of the address. Allowable Values: 32 char max |
data[].config.fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
data[].config.fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. Allowable Values:
|
data[].config.fulfillment.shipping.return_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].config.fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].config.fulfillment.shipping.return_address.city
string
|
City of the address. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.return_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
data[].config.fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
data[].config.fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
data[].config.fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
data[].config.fulfillment.shipping.return_address.state
string
|
State of the address. Allowable Values: 32 char max |
data[].config.fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
data[].config.fulfillment.uppercase_name_lines
boolean
|
A value of Allowable Values:
Default value: |
data[].config.jit_funding
object
|
Governs the behavior of JIT Funding. Allowable Values:
|
data[].config.jit_funding.paymentcard_funding_source
object
|
Enables and configures a payment card funding source. Allowable Values: Valid |
data[].config.jit_funding.paymentcard_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the payment card funding source.
A value of Allowable Values:
Default value: |
data[].config.jit_funding.paymentcard_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal. Allowable Values:
|
data[].config.jit_funding.program_funding_source
object
|
Enables and configures a program funding source. Allowable Values: Valid |
data[].config.jit_funding.program_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program funding source.
A value of Allowable Values:
Default value: |
data[].config.jit_funding.program_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
data[].config.jit_funding.program_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
Allowable Values:
|
data[].config.jit_funding.programgateway_funding_source
object
|
Enables and configures a program gateway funding source. Allowable Values: Valid |
data[].config.jit_funding.programgateway_funding_source.always_fund
boolean
|
If set to Allowable Values:
Default value: |
data[].config.jit_funding.programgateway_funding_source.enabled
boolean
|
Specifies whether JIT Funding is enabled or disabled for the program gateway funding source.
A value of Allowable Values:
Default value: |
data[].config.jit_funding.programgateway_funding_source.funding_source_token
string
|
Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Allowable Values: 36 char max |
data[].config.jit_funding.programgateway_funding_source.refunds_destination
string
|
Specifies the return destination for refunds in the case of a transaction reversal.
In most cases, you should set the value to Allowable Values:
|
data[].config.poi
object
|
Governs the point of interaction. Allowable Values:
|
data[].config.poi.atm
boolean
|
If set to Allowable Values:
Default value: |
data[].config.poi.ecommerce
boolean
|
If set to Allowable Values:
Default value: |
data[].config.poi.other
object
|
Allows for configuration of points of interaction other than ecommerce or ATMs, such as points of sale (POS). Allowable Values:
|
data[].config.poi.other.allow
boolean
|
If set to Allowable Values:
Default value: |
data[].config.poi.other.card_presence_required
boolean
|
If set to Allowable Values:
Default value: |
data[].config.poi.other.cardholder_presence_required
boolean
|
If set to Allowable Values:
Default value: |
data[].config.selective_auth
object
|
Contains information about authorization decisions. Allowable Values:
|
data[].config.selective_auth.dmd_location_sensitivity
integer
|
Determines what type of merchant information is required for a match (authorization).
Not relevant if
Allowable Values:
Default value: |
data[].config.selective_auth.enable_regex_search_chain
boolean
|
Set to Allowable Values:
Default value: |
data[].config.selective_auth.sa_mode
integer
|
Specifies the selective authorization mode.
Selective authorization applies to transactions that are limited to specific merchants.
Matching requirements for authorization are set by the Allowable Values:
Default value: |
data[].config.special
object
|
Contains information about merchant onboarding. Allowable Values:
|
data[].config.special.merchant_on_boarding
boolean
|
If set to Allowable Values:
Default value: |
data[].config.transaction_controls
object
|
Controls transactional characteristics of card usage. Allowable Values:
|
data[].config.transaction_controls.accepted_countries_token
string
|
Set to Set to Users with the Admin role can create and update additional lists of accepted countries for transactions at the Allowable Values:
Default value: |
data[].config.transaction_controls.address_verification
object
|
Contains configuration options for AVS. Allowable Values: Valid |
data[].config.transaction_controls.address_verification.auth_messages
object
|
Contains verification options for authorization messages. These messages pertain to actual purchases and are for amounts greater than $0. Allowable Values: One or more verification options |
data[].config.transaction_controls.address_verification.av_messages
object
|
Contains verification options for account verification messages. These are $0 messages typically used to store cards on file at a merchant. Allowable Values: One or more verification options |
data[].config.transaction_controls.allow_chip_fallback
boolean
|
Indicates whether to allow transactions where a Europay Mastercard and Visa (EMV) chip-enabled card was processed using the magstripe as fallback. Allowable Values:
Default value: |
data[].config.transaction_controls.allow_first_pin_set_via_financial_transaction
boolean
|
WARNING: This field is deprecated and will be unsupported in a future release. Allows cardholders to define a personal identification number (PIN) as they complete their first PIN-debit transaction. Allowable Values:
Default value: |
data[].config.transaction_controls.allow_gpa_auth
boolean
|
If set to NOTE: For most programs, this field should be set to Allowable Values:
Default value: |
data[].config.transaction_controls.allow_mcc_group_authorization_controls
boolean
|
The MCC group NOTE: Partial authorizations are disallowed if this field is set to Allowable Values:
Default value: |
data[].config.transaction_controls.allow_network_load
boolean
|
Indicates whether card network loads are allowed.
The associated card’s state must be Allowable Values:
Default value: |
data[].config.transaction_controls.allow_network_load_card_activation
boolean
|
Indicates whether card network loads are allowed.
Sets the associated card’s state to Allowable Values:
Default value: |
data[].config.transaction_controls.allow_quasi_cash
boolean
|
Indicates whether quasi-cash transactions are allowed. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values:
Default value: |
data[].config.transaction_controls.always_require_icc
boolean
|
If set to Allowable Values:
Default value: |
data[].config.transaction_controls.always_require_pin
boolean
|
If set to Allowable Values:
Default value: |
data[].config.transaction_controls.enable_partial_auth_approval
boolean
|
Set to When this setting is Allowable Values:
Default value: |
data[].config.transaction_controls.ignore_card_suspended_state
boolean
|
Allows transactions to be approved even if the card’s Allowable Values:
Default value: |
data[].config.transaction_controls.notification_language
string
|
Specifies the language for 3D Secure and digital wallet token notifications sent to cardholders under this card program. You can send notifications to your cardholders in the following languages:
By default, notifications are sent in English. To specify the language for OTP notifications at the user level, see Users. Languages set at the user level take precedence over the language set at the card product level. Allowable Values:
If you leave this field blank, cardholders receive notifications in English. |
data[].config.transaction_controls.quasi_cash_exempt_merchant_group_token
string
|
The token of the merchant group that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. You can specify a merchant group token in addition to whatever merchant identifiers you listed in the Allowable Values: 1–36 chars Valid merchant group token. |
data[].config.transaction_controls.quasi_cash_exempt_mids
string
|
Comma-separated list of merchant identifiers that you want to exempt from quasi-cash transaction authorization control, allowing your cardholders to conduct quasi-cash transactions. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Allowable Values: 255 char max For example: |
data[].config.transaction_controls.require_card_not_present_card_security_code
boolean
|
A value of Allowable Values:
Default value: |
data[].config.transaction_controls.strong_customer_authentication_limits
object
|
Contains information about Strong Customer Authentication (SCA) behavior for contactless point-of-sale (POS) and low-value payment (LVP) e-commerce transactions. Allowable Values:
|
data[].config.transaction_controls.strong_customer_authentication_limits.sca_contactless_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single contactless point-of-sale (POS) transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. A value of Allowable Values: decimal Format: There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_count_limit
integer
|
Specifies the number of contactless POS transactions the cardholder can perform before receiving an SCA challenge. A value of Allowable Values: Any integer, such as There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_contactless_transactions_currency
string
|
Specifies the currency type for contactless POS transactions. This field is required if either the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_lvp_cumulative_amount_limit
decimal
|
Specifies the cumulative limit of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. For example, if you set the value of this field to If you leave this field blank, the cumulative amount spent in LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transaction_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. If you leave this field blank, the amount of any single LVP e-commerce transaction performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: decimal Format: There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_count_limit
integer
|
Specifies the number of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. If you leave this field blank, the total number of LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Allowable Values: An integer, such as There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_lvp_transactions_currency
string
|
Specifies the currency type for LVP e-commerce transaction limits. This field is required if any one of the Allowable Values: Valid three-digit ISO 4217 currency type, such as There is no default value for this field. |
data[].config.transaction_controls.strong_customer_authentication_limits.sca_tra_exemption_amount_limit
decimal
|
Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction with transaction risk analysis (TRA) exemption sent by the merchant or acquirer.
If the transaction amount exceeds the specified limit, then the transaction is either approved or it receives a strong customer authentication (SCA) challenge based on Allowable Values: decimal Format: Default value: |
data[].created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: datetime Format: |
data[].end_date
date
|
End date of the range over which the card product can be active. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-mm-DD |
data[].last_modified_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: |
data[].name
string
|
Name of the card product. Allowable Values: 1–40 chars |
data[].start_date
date
|
Date when the card product becomes active. Allowable Values: Format: yyyy-mm-DD |
data[].token
string
|
Unique identifier of the card product. Allowable Values: 1–36 chars If you did not include a token in your request, the system returns an automatically generated token in the response. |
end_index
integer
|
Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of This field is returned if there are resources in your returned array. Allowable Values:
|
start_index
integer
|
Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Update card product
Copy section link
Action: PUT
Endpoint: /cardproducts/{token}
Use this endpoint to update a card product. Only values of fields in the request are modified; all others are left unchanged.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the card product to update. Allowable Values: Existing card product token |
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Indicates whether the card product is active. NOTE: This field has no effect on the ability to create cards from this card product.
Use the Allowable Values:
Default value: |
config
object
|
Defines the characteristics of the card product. Configurations are conditionally required based on program setup. Allowable Values:
|
config.card_life_cycle
object
|
Defines characteristics of the lifecycle of cards of this card product type. Allowable Values:
|
config.card_life_cycle.activate_upon_issue
boolean
|
A value of Allowable Values:
Default value: |
config.card_life_cycle.card_service_code
integer
|
Sequence of three digits that defines various services, differentiates card usage in international or domestic interchange, designates personal identification number (PIN) and authorization requirements, and identifies card restrictions. The following values are commonly used: First digit
Second digit
Third digit
Allowable Values: 100 - 999 Default value: |
config.card_life_cycle.expiration_offset
object
|
Specifies the length of time after the date of issue for which cards of this card product type are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset
object
|
Specifies the minimum length of time after the date of issue for which the cards are valid. Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.unit
string
|
Specifies the time unit of the Allowable Values:
|
config.card_life_cycle.expiration_offset.min_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
config.card_life_cycle.expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
config.card_life_cycle.update_expiration_upon_activation
boolean
|
Normally, the Allowable Values:
Default value: |
config.clearing_and_settlement
object
|
Specifies the destination for overdraft funds. Allowable Values:
|
config.clearing_and_settlement.overdraft_destination
string
|
Specifies the destination for overdraft funds. This field does not apply if JIT Funding is enabled. Allowable Values:
Default value: |
config.digital_wallet_tokenization
object
|
Controls characteristics related to digital wallets. Allowable Values:
|
config.digital_wallet_tokenization.card_art_id
string
|
Specifies the digital wallet card art identifier for the card product. Digital wallets display the card art after the initial token has been provisioned and activated. Digital wallet card art is updated for all wallets automatically whenever a tokenized card is reissued or replaced.
If this field is left blank, your card product inherits the card art assigned to the account BIN range. Allowable Values: Valid identifiers are defined by Visa or Mastercard and vary by program:
|
config.digital_wallet_tokenization.provisioning_controls
object
|
Controls the provisioning of digital wallets. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.in_app_provisioning
object
|
Controls the provisioning of digital wallets by a Marqeta customer’s mobile application. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.manual_entry
object
|
Controls the provisioning of digital wallets by manual entry, in which the cardholder manually enters the card’s primary account number (PAN), card verification value (CVV2), and expiration date. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.wallet_provider_card_on_file
object
|
Controls the provisioning of digital wallets where the digital wallet provider already has the card on file. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.web_push_provisioning
object
|
Specifies the digital wallet card art and program configuration identifiers at the card product level for Web Push Provisioning. Allowable Values: Valid |
config.digital_wallet_tokenization.provisioning_controls.dwt_use_card_status_during_auth
boolean
|
If Allowable Values:
Default value: |
config.fulfillment
object
|
Determines physical characteristics of a card, along with its bulk shipment information. Allowable Values:
|
config.fulfillment.all_zero_card_security_code
boolean
|
If Allowable Values:
Default value: |
config.fulfillment.allow_card_creation
boolean
|
Controls the ability to create cards from this card product; NOTE: The card product’s Allowable Values:
Default value: |
config.fulfillment.bin_prefix
string
|
Prefix of the bank identification number. Allowable Values: A six-digit number for the sandbox environment; a six- to nine-digit number is expected in production environments (see note below). Default value: NOTE: In the sandbox environment or when testing against OpenAPI (Swagger), this field must be set to |
config.fulfillment.bulk_ship
boolean
|
Enables bulk ordering of cards of this card product type using the Allowable Values:
Default value: |
config.fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card product. Allowable Values: Valid |
config.fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
config.fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
config.fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
config.fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
config.fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values:
|
config.fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
config.fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
config.fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
config.fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
config.fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
config.fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
config.fulfillment.enable_offline_pin
boolean
|
Enables offline personal identification number (PIN) verification for Europay Mastercard and Visa (EMV, or "chip-and-PIN") card payments. Allowable Values:
Default value: |