# Card Tokens > Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations. ## The Card Token object ### Example ```json { "created_at": "2020-01-31T23:59:59Z", "expiration_date": "2020-01-31", "id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "last4": "1234", "length": 16, "prefix": "46637100", "type": "card_token" } ``` ### Attributes - `created_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card token was created. - `expiration_date` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card expires. - `id` (string) The Card Token's identifier. - `last4` (string) The last 4 digits of the card number. - `length` (integer) The length of the card number. - `prefix` (string) The prefix of the card number, usually 8 digits. - `type` (string) A constant representing the object's type. For this resource it will always be `card_token`. ## List Card Tokens GET /card_tokens ### Example ```curl curl \ --url "${INCREASE_URL}/card_tokens" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Query Parameters - `cursor` (string, optional) Return the page of entries after this one. - `limit` (integer, optional) Limit the size of the list that is returned. The default (and maximum) is 100 objects. - `created_at.after` (string, optional) Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.before` (string, optional) Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_after` (string, optional) Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_before` (string, optional) Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. ### Returns a Card Token List object: ```json { "data": [ { "created_at": "2020-01-31T23:59:59Z", "expiration_date": "2020-01-31", "id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "last4": "1234", "length": 16, "prefix": "46637100", "type": "card_token" } ], "next_cursor": "v57w5d" } ``` ## Retrieve a Card Token GET /card_tokens/{card_token_id} ### Example ```curl curl \ --url "${INCREASE_URL}/card_tokens/outbound_card_token_zlt0ml6youq3q7vcdlg0" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path Parameters - `card_token_id` (string, required) The identifier of the Card Token. ## Retrieve the capabilities of a Card Token GET /card_tokens/{card_token_id}/capabilities > The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range. ### Example ```curl curl \ --url "${INCREASE_URL}/card_tokens/outbound_card_token_zlt0ml6youq3q7vcdlg0/capabilities" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path Parameters - `card_token_id` (string, required) The identifier of the Card Token. ### Returns a Card Token Capabilities object: ```json { "routes": [ { "cross_border_push_transfers": "not_supported", "domestic_push_transfers": "supported", "issuer_country": "US", "route": "visa" } ], "type": "card_token_capabilities" } ``` ## Sandbox: Create a Card Token POST /simulations/card_tokens > Simulates tokenizing a card in the sandbox environment. ### Example ```curl curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_tokens" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "capabilities": [ { "cross_border_push_transfers": "supported", "domestic_push_transfers": "supported", "route": "visa" } ], "expiration": "2020-01-31T23:59:59Z", "last4": "1234", "prefix": "41234567", "primary_account_number_length": 16 }' ``` ### Body Parameters - `capabilities` (array of objects, optional) The capabilities of the outbound card token. - `capabilities.cross_border_push_transfers` (enum, required) The cross-border push transfers capability. Cases: * `supported` (The capability is supported.) * `not_supported` (The capability is not supported.) - `capabilities.domestic_push_transfers` (enum, required) The domestic push transfers capability. Cases: * `supported` (The capability is supported.) * `not_supported` (The capability is not supported.) - `capabilities.route` (enum, required) The route of the capability. Cases: * `visa` (Visa and Interlink) * `mastercard` (Mastercard and Maestro) - `expiration` (string, optional) The expiration date of the card. - `last4` (string, optional) The last 4 digits of the card number. - `outcome` (dictionary, optional) The outcome to simulate for card push transfers using this token. - `outcome.decline` (dictionary, optional) If the result is declined, the details of the decline. - `outcome.decline.reason` (enum, optional) The reason for the decline. Cases: * `do_not_honor` (The card issuer has declined the transaction without providing a specific reason.) * `activity_count_limit_exceeded` (The number of transactions for the card has exceeded the limit set by the issuer.) * `refer_to_card_issuer` (The card issuer requires the cardholder to contact them for further information regarding the transaction.) * `refer_to_card_issuer_special_condition` (The card issuer requires the cardholder to contact them due to a special condition related to the transaction.) * `invalid_merchant` (The merchant is not valid for this transaction.) * `pick_up_card` (The card should be retained by the terminal.) * `error` (An error occurred during processing of the transaction.) * `pick_up_card_special` (The card should be retained by the terminal due to a special condition.) * `invalid_transaction` (The transaction is invalid and cannot be processed.) * `invalid_amount` (The amount of the transaction is invalid.) * `invalid_account_number` (The account number provided is invalid.) * `no_such_issuer` (The issuer of the card could not be found.) * `re_enter_transaction` (The transaction should be re-entered for processing.) * `no_credit_account` (There is no credit account associated with the card.) * `pick_up_card_lost` (The card should be retained by the terminal because it has been reported lost.) * `pick_up_card_stolen` (The card should be retained by the terminal because it has been reported stolen.) * `closed_account` (The account associated with the card has been closed.) * `insufficient_funds` (There are insufficient funds in the account to complete the transaction.) * `no_checking_account` (There is no checking account associated with the card.) * `no_savings_account` (There is no savings account associated with the card.) * `expired_card` (The card has expired and cannot be used for transactions.) * `transaction_not_permitted_to_cardholder` (The transaction is not permitted for this cardholder.) * `transaction_not_allowed_at_terminal` (The transaction is not allowed at this terminal.) * `transaction_not_supported_or_blocked_by_issuer` (The transaction is not supported or has been blocked by the issuer.) * `suspected_fraud` (The transaction has been flagged as suspected fraud and cannot be processed.) * `activity_amount_limit_exceeded` (The amount of activity on the card has exceeded the limit set by the issuer.) * `restricted_card` (The card has restrictions that prevent it from being used for this transaction.) * `security_violation` (A security violation has occurred, preventing the transaction from being processed.) * `transaction_does_not_fulfill_anti_money_laundering_requirement` (The transaction does not meet the anti-money laundering requirements set by the issuer.) * `blocked_by_cardholder` (The transaction was blocked by the cardholder.) * `blocked_first_use` (The first use of the card has been blocked by the issuer.) * `credit_issuer_unavailable` (The credit issuer is currently unavailable to process the transaction.) * `negative_card_verification_value_results` (The card verification value (CVV) results were negative, indicating a potential issue with the card.) * `issuer_unavailable` (The issuer of the card is currently unavailable to process the transaction.) * `financial_institution_cannot_be_found` (The financial institution associated with the card could not be found.) * `transaction_cannot_be_completed` (The transaction cannot be completed due to an unspecified reason.) * `duplicate_transaction` (The transaction is a duplicate of a previous transaction and cannot be processed again.) * `system_malfunction` (A system malfunction occurred, preventing the transaction from being processed.) * `additional_customer_authentication_required` (Additional customer authentication is required to complete the transaction.) * `surcharge_amount_not_permitted` (The surcharge amount applied to the transaction is not permitted by the issuer.) * `decline_for_cvv2_failure` (The transaction was declined due to a failure in verifying the CVV2 code.) * `stop_payment_order` (A stop payment order has been placed on this transaction.) * `revocation_of_authorization_order` (An order has been placed to revoke authorization for this transaction.) * `revocation_of_all_authorizations_order` (An order has been placed to revoke all authorizations for this cardholder.) * `unable_to_locate_record` (The record associated with the transaction could not be located.) * `file_is_temporarily_unavailable` (The file needed for the transaction is temporarily unavailable.) * `incorrect_pin` (The PIN entered for the transaction is incorrect.) * `allowable_number_of_pin_entry_tries_exceeded` (The allowable number of PIN entry tries has been exceeded.) * `unable_to_locate_previous_message` (The previous message associated with the transaction could not be located.) * `pin_error_found` (An error was found with the PIN associated with the transaction.) * `cannot_verify_pin` (The PIN associated with the transaction could not be verified.) * `verification_data_failed` (The verification data associated with the transaction has failed.) * `surcharge_amount_not_supported_by_debit_network_issuer` (The surcharge amount is not supported by the debit network issuer.) * `cash_service_not_available` (Cash service is not available for this transaction.) * `cashback_request_exceeds_issuer_limit` (The cashback request exceeds the issuer limit.) * `transaction_amount_exceeds_pre_authorized_approval_amount` (The transaction amount exceeds the pre-authorized approval amount.) * `transaction_does_not_qualify_for_visa_pin` (The transaction does not qualify for Visa PIN processing.) * `offline_declined` (The transaction was declined offline.) * `unable_to_go_online` (The terminal was unable to go online to process the transaction.) * `valid_account_but_amount_not_supported` (The account is valid but the transaction amount is not supported.) * `invalid_use_of_merchant_category_code_correct_and_reattempt` (The merchant category code was used incorrectly; correct it and reattempt the transaction.) * `card_authentication_failed` (The card authentication process has failed.) - `outcome.result` (enum, required) Whether card push transfers or validations will be approved or declined. Cases: * `approve` (Any card push transfers or validations will be approved.) * `decline` (Any card push transfers or validations will be declined.) - `prefix` (string, optional) The prefix of the card number, usually the first 8 digits. - `primary_account_number_length` (integer, optional) The total length of the card number, including prefix and last4.