Create a Card
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.
Body Parameters
Account Id.
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
Data required to order cards that will be shipped to an address other than the default account shipping address.
Show child attributes
Card Profile Id. Card profiles are used to set default values for cards. Like embossing and usage type.
Id of department.
A driver will be created and associated to this card with this driver information if this is a driver card or 1:1 plus card. If no information is provided, and this is a driver card, a driver will be created with default information and associated this card. Only required for Driver cards or 1:1 plus cards.
Show child attributes
Show child attributes
Often used to store a unique identifier for the employee assigned to the card.
Request electric vehicle charging access.
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.
This field should be set to true unless your company produces its own cards or you are doing a batch order.
Purchase Control Id. Also known as Purchase Control id. Used to set control limits for cards. If no value is provided the default value for the account will be used.
Reference Id. Place for customers to add custom data.
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
A vehicle will be created and associated to this card with this vehicle information. If no information is provided and this is an asset card a vehicle will be created with default information and associated this card. Only required for Vehicle (Asset) cards or 1:1 plus cards.
Show child attributes
Response
The card that was created.
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
Response