---
title: "Update card token"
method: PUT
path: "/pay/v3/vault/card/{cardToken}"
tags: ["Ecommerce"]
---

# Update card token

`PUT /pay/v3/vault/card/{cardToken}`

Allows you to edit the card information, account updater status, and customer information for an existing card or terminal token. To get the current card information for a token, see the [View card tokens](https://docs.nexiopay.com/reference/viewcardtokens) or [View card token details](https://docs.nexiopay.com/reference/viewcardtokendetails) endpoints.

<!-- theme: info -->
> 📘 Note
> 
> - Card tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.
> - Use this endpoint to register/deregister card tokens with the account updater service.
> - Cards registered with the account updater service may take up to 72 hours to be deregistered.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
> username: `docs@nexiopay.com`
> password: `JZdzoXpdDeH6VA`<br/><br/>Include a saved card or terminal token in the path parameter of the request, along with the new token information in the body of the request. (Due to technical limitations, the **Try It** feature does not support the use of a terminal token.)

<div style="display:none;">

## Request parameters
- cardToken
- card
- card.expirationMonth
- card.expirationYear
- card.cardHolderName
- card.cardType
- card.firstSix
- card.lastFour
- data
- data.customer
- data.customer.billToAddressOne
- data.customer.billToAddressTwo
- data.customer.billToCity
- data.customer.billToCountry
- data.customer.billToPhone
- data.customer.billToPostal
- data.customer.billToState
- data.customer.birthDate
- data.customer.customerRef
- data.customer.email
- data.customer.firstName
- data.customer.lastName
- data.customer.phone
- data.customer.shipToAddressOne
- data.customer.shipToAddressTwo
- data.customer.shipToCity
- data.customer.shipToCountry
- data.customer.shipToPhone
- data.customer.shipToPostal
- data.customer.shipToState
- shouldUpdateCard

## Response parameters
- accountUpdaterStatus
- dateCreated
- dateLastModified
- merchantId
- shouldUpdateCard
- currencyCode
- card
- card.expirationMonth
- card.expirationYear
- card.cardHolderName
- card.cardType
- card.cardNumber
- card.firstSix
- card.lastFour
- data
- data.customer
- data.customer.customerRef
- data.customer.birthDate
- data.customer.email
- data.customer.firstName
- data.customer.lastName
- data.customer.phone
- data.customer.billToAddressOne
- data.customer.billToAddressTwo
- data.customer.billToCity
- data.customer.billToState
- data.customer.billToPostal
- data.customer.billToCountry
- data.customer.billToPhone
- data.customer.shipToAddressOne
- data.customer.shipToAddressTwo
- data.customer.shipToCity
- data.customer.shipToState
- data.customer.shipToPostal
- data.customer.shipToCountry
- data.customer.shipToPhone
- tokenex
- tokenex.cardType
- tokenex.firstSix
- tokenex.lastFour
- tokenex.token
- originalCard
- originalCard.cardHolderName
- originalCard.expirationMonth
- originalCard.expirationYear

</div>

## Path parameters

- `cardToken` string, required

## Request body

- object
  - `card` object — Card information you wish to edit. Only provided fields will be edited
    - `cardType` 'amex' | 'discover' | 'jcb' | 'mastercard' | 'visa' — The card type. This parameter only gets returned here if the token is a terminal token. However, not all connections for terminals return this value. **Note:** This is the card type used with a terminal and not the card type from a saved card token. See the `tokenex` object for the `cardType` for a saved card token.
    - `cardHolderName` string — The cardholder's name as it appears on the card. This value is saved in the card token.
    - `firstSix` string — The first six digits of the card number. For saved card tokens, the system updates this value in `tokenex.firstSix`. For terminal tokens, the system updates this value in `card.firstSix`.
    - `lastFour` string — The last four digits of the card number. For saved card tokens, the system updates this value in `tokenex.lastFour`. For terminal tokens, the system updates this value in `card.lastFour`.
    - `expirationMonth` string — The two-digit month in which the card will expire. This value is saved in the card token.
    - `expirationYear` string — The two-digit or four-digit year in which the card expires. This value is saved in the card token.
  - `data` object — Optional data you wish to edit. Only provided fields will be edited
    - `customer` object — Customer information to be used in checking fraud or sent to the processing gateway, when applicable.
      - `customerRef` string — Customer identifier. You can use this field to pass a customer ID to the gateway or APM or to manage user subscriptions. This value is saved in the card/echeck token.
      - `firstName` FirstName — unresolved $ref
      - `lastName` LastName — unresolved $ref
      - `birthDate` BirthDate — unresolved $ref
      - `email` Email — unresolved $ref
      - `phone` Phone — unresolved $ref
      - `billToAddressOne` BillToAddressOne — unresolved $ref
      - `billToAddressTwo` BillToAddressTwo — unresolved $ref
      - `billToCity` BillToCity — unresolved $ref
      - `billToState` BillToState — unresolved $ref
      - `billToPostal` BillToPostal — unresolved $ref
      - `billToCountry` BillToCountry — unresolved $ref
      - `billToPhone` BillToPhone — unresolved $ref
      - `shipToAddressOne` ShipToAddressOne — unresolved $ref
      - `shipToAddressTwo` ShipToAddressTwo — unresolved $ref
      - `shipToCity` ShipToCity — unresolved $ref
      - `shipToState` ShipToState — unresolved $ref
      - `shipToPostal` ShipToPostal — unresolved $ref
      - `shipToCountry` ShipToCountry — unresolved $ref
      - `shipToPhone` ShipToPhone — unresolved $ref
  - `shouldUpdateCard` boolean — The card's account updater [enrollment tag](https://docs.nexiopay.com/docs/checking-a-cards-enrollment-tag). This value is cached in the one-time-use token. When true, the card or e-check token is tagged for being sent to the account updater provider. <!-- theme:info --> > #### Note > The card or e-check will not be registered until the merchant account is enrolled. See the [Enrollment tag table](https://docs.nexiopay.com/docs/checking-a-cards-enrollment-tag#enrollment-tag-table) for more information.

## Response `200`

Success

- object
  - `dateCreated` DateCreated — unresolved $ref
  - `dateLastModified` DateLastModified — unresolved $ref
  - `merchantId` MerchantId — unresolved $ref
  - `currencyCode` string — The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the card. This parameter only gets returned if the token is a saved card token.
  - `card` object — Card information
    - `cardType` 'amex' | 'discover' | 'jcb' | 'mastercard' | 'visa' — The card type. **Note:** For terminal-based tokens, not all connectors return this value.
    - `cardHolderName` CardHolderName — unresolved $ref
    - `cardNumber` CardNumber — unresolved $ref
    - `firstSix` FirstSix — unresolved $ref
    - `lastFour` LastFour — unresolved $ref
    - `expirationMonth` string — The one-digit or two-digit month in which the card expires.
    - `expirationYear` string — The two-digit or four-digit year in which the card expires.
  - `originalCard` object — Original card details. This object only gets returned here if the token is a saved card token.
    - `cardHolderName` string — The cardholder's name, as specified when the card token was created. This parameter only gets returned here if the token is a saved card token.
    - `expirationMonth` string — The one-digit or two-digit month in which the card expires, as specified when the card token was created. This parameter only gets returned here if the token is a saved card token.
    - `expirationYear` string — The two-digit year in which the card expires, as specified when the card token was created. This parameter only gets returned here if the token is a saved card token.
  - `tokenex` object — The card token information. This object only gets returned if the token is a saved card token.
    - `token` Token — unresolved $ref
    - `cardType` 'amex' | 'discover' | 'jcb' | 'mastercard' | 'visa' — The card type for the saved card token.
    - `firstSix` string — The first six digits of the card number. This value is saved in the card token (copied from `card.firstSix`).
    - `lastFour` string — The last four digits of the card number. This value is saved in the card token (copied from `card.lastFour`).
  - `data` object — Additional data attached to the card token
    - `customer` object — Customer information.
      - `customerRef` string — Customer identifier. This field may have been used to pass a customer ID to the gateway or to manage user subscriptions.
      - `firstName` FirstName — unresolved $ref
      - `lastName` LastName — unresolved $ref
      - `birthDate` string — The customer's date of birth. The format returned matches the format used in the request.
      - `email` Email — unresolved $ref
      - `phone` BillToPhone — unresolved $ref
      - `billToAddressOne` BillToAddressOne — unresolved $ref
      - `billToAddressTwo` BillToAddressTwo — unresolved $ref
      - `billToCity` BillToCity — unresolved $ref
      - `billToState` BillToState — unresolved $ref
      - `billToPostal` BillToPostal — unresolved $ref
      - `billToCountry` BillToCountry — unresolved $ref
      - `billToPhone` BillToPhone — unresolved $ref
      - `shipToAddressOne` ShipToAddressOne — unresolved $ref
      - `shipToAddressTwo` ShipToAddressTwo — unresolved $ref
      - `shipToCity` ShipToCity — unresolved $ref
      - `shipToState` ShipToState — unresolved $ref
      - `shipToPostal` ShipToPostal — unresolved $ref
      - `shipToCountry` ShipToCountry — unresolved $ref
      - `shipToPhone` ShipToPhone — unresolved $ref
  - `shouldUpdateCard` boolean — The card's account updater [enrollment tag](https://docs.nexiopay.com/docs/checking-a-cards-enrollment-tag). This parameter only gets returned if the token is a saved card token.
  - `accountUpdaterStatus` AccountUpdaterStatus — unresolved $ref
  - `random` RandomNnnn — unresolved $ref

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/nexiopay/apis/payments-api-reference/revisions/b414b73979e5?raw)