Update a card record
Header Parameters
Optional audit field that indicates the User that performed a change. This field cannot be updated directly without appropriate permission - it is automatically set to the clientId of the authenticated User making the request.
Path Parameters
The id for the card
Body Parameters
Address used in card orders and saved on the card for reuse.
Show child attributes
The card profile id for the card. This will trigger a card reissue.
The department id for the card. Not all accounts use this field.
The design code for the card. This will trigger a card reissue. This field can be used to change the card profile if the card profile id is not known.
Use this field in conjunction with the resetPrompt field. Set a new driver prompt id. Only available if your account has a customer prompt value of true and your card usage type supports a driver prompt id.
Show child attributes
Request electric vehicle charging access. This field is only editable if the card is not currently set up for electric vehicle charging.
An alpha-numeric identifier used by partners to link to their internal systems. Can be 5, 10 or 15 characters depending on account set up.
The Purchase Control id for the card.
Reference Id. A Place for customers to add custom data.
Set this value to true if you want to reset the prompt id for this card. If your cards have a customer generated prompt id set the appropriate prompt id for this card with the new value. If you have a system generated prompt id you will only need to set this value to true.
Show child attributes
Indicates if the card should be sent to a shipping address that will be stored for reuse.
A list of User Defined Fields.
Show child attributes
Response
The card with the new values added.
Response Attributes
HATEOAS links related to the card.
Show child attributes
Account Id.
Name of the account.
Batch order number associated with card creation. Use this value to group cards together and order them as a single batch. This value can be set by the user on the card creation request.
Address used in card orders and saved on the card for reuse.
Show child attributes
Card Id.
Card Locked Flag
Card Number.
Card Profile Id.
Card Profile Name.
Last digit of the MagStrip number.
Valid Card Types:
Custom Control
Fuel Only
Fuel and Oil
Unrestricted
WEX Edge
CarAdvise
Department object.
Show child attributes
Design code used determine properties on the card.
Driver Id.
Prompt Id for the driver.
Embossed Number. Used by businesses to store special card numbers.
Used by businesses to store vehicle information or other information that is important to them. The embossing can be customer defined or linked to other attributes on other entities based on the embossing specification defined by the card profile.
Show child attributes
Request electric vehicle charging access.
The date electric vehicle charging access was requested. Format: YYYY-MM-DDTHH:MM:SSZ.
The date the card expires. Format: YYYY-MM-DDTHH:MM:SSZ
Date card was last issued. Format: YYYY-MM-DDTHH:MM:SSZ.
Date card was last changed. Format: YYYY-MM-DDTHH:MM:SSZ.
License Plate Number.
Magnetic Strip Number.
Order Id.
An alpha-numeric identifier used by partners to link to their internal systems. Can be 5, 10 or 15 characters depending on account set up.
Point of Sale prompting for display.
Point of Sale prompting override.
Purchase Control Id.
Purchase Control Name.
Reference Id. Place for customers to throw goo...
Indicates if the card is eligible for renewal.
Renewal period.
List of RFID's associated to the card.
Show child attributes
The status of the card.
Describes the reason for the card status. A card may be in suspended status because it was reported lost.
Valid usage types: Asset Driver Driver 1:1 Driver 1:1 Plus Site Usage Vehicle 1:1 Vehicle 1:1 Plus
Indicates if the card should be sent to a shipping address that will be stored for reuse.
User Defined Fields.
Show child attributes
Vehicle Customer Id.
Vehicle Description.
Vehicle Id.
Prompt Id for the vehicle.
Vehicle Identification Number.
Invalid request body
Response Attributes
The supplied user does not have access to the associated account(s)
Response Attributes
Invalid Id