Cards

This section provides a detailed overview of the Fleet Service API's card operational logic.

account_id - The Account ID is fundamental to the Fleet Service API, serving as the primary identifier for all entities. Every request to the API requires a valid Account ID to locate specific information.

authorization_control_id - If you omit the authorization control ID, the system will automatically apply the default ID associated with the specified account. To use a different authorization control ID, you can retrieve a list of available IDs for the account using the Account endpoint (account/{accountId}/authorization profiles), select your preferred ID, and include it in your request.

batch_order_number - To have the system automatically generate a batch order number, initiate a batch order by creating your first card and leaving the batch order number field empty. The system will return a card object containing the newly generated batch order number. For all subsequent cards intended for the same address within that batch, simply assign this same batch order number. All cards for a specific account ordered on the same day and sharing the same batch order number will be grouped together for shipping to the client.

card_address - The shipping address is linked to a specific card. The card_address functionality is governed by the following business rules:

• card_address must be enabled at the account level before it can be used.

• When replacing a lost or stolen card, if the "use address on card" option is selected, the replacement card will always be shipped to the existing card_address.

card_profile_id - The card_profile_id is a mandatory field that specifies the physical characteristics of the card, including the number of embossed fields, color, and logos. To obtain a valid card_profile_idfor an account, use the GET/accounts/{accountId}/card-profiles endpoint. This will return a list of available card profiles; select the desired profile and use its id in this field. Note: Changing the card_profile_id will result in the card being reissued.

Embossing - The card profile will automatically populate these fields with default values from predefined sources. However, you have the flexibility to override these defaults and enter custom values for any of the string fields provided.

employee_number - The employee_number field is optional. You can enter any value you choose in this field.

enhanced_profile_id - This field is optional and can typically be left blank unless you have a specific need for it.

ev_requested - The ev_requested setting is configured at the account level. If your account has EV (Electric Vehicle) functionality enabled, you can set this ev_requested field to true. Doing so will associate an EV RFID tag with the card.

produce_card - The produce_card field should generally be set to true. This action will both create the card record and initiate an order for its physical production and shipment. If you set produce_card to false, the card record will be created, but no physical card will be ordered or shipped. Exception: When batch ordering cards, you must set produce_card to false. The batch order endpoint will handle the creation of a single order for all cards in the batch, assigning them the same batch number and arranging for their shipment together.

order_id - When you create a card and setproduce_card to true (indicating a physical card should be produced), the system will generate an order, and its unique identifier will be populated in the order_id field.

reference_id - You can enter whatever you want in this field.

renewal_period - This setting is configured at the account level and cannot be modified for individual cards. use_address_on_card - This setting can be configured for individual cards. When creating a card, if you set this field to true, the Fleet Service API will use the specific address associated with that card for shipping purposes.

usage_type- There are two types of cards - Vehicle and Driver cards.

• Vehicle Cards: Vehicle cards are assigned to specific vehicles or assets. This allows the fleet to monitor vehicle-related expenses, such as fuel costs, and track performance metrics like mileage, fuel efficiency (MPG), and cost per mile.

• Vehicle/Multi-Driver Card: 1:M This card is linked to a single vehicle. Each authorized driver using the card must enter their unique Authorization Prompt ID, enabling the system to track both vehicle-related expenses and individual driver purchase activity.

• Vehicle/Single Driver Card 1:1 Plus This card is dedicated to a specific vehicle and is associated with a single, unique Authorization Prompt ID, which is known only to one designated driver. This one-to-one assignment provides a high level of security for transactions.

• Vehicle Card 1:1 Dedicated to a specific vehicle or asset, this card operates with a single Authorization Prompt ID. Drivers using this card do not enter their own unique IDs; instead, they utilize the shared Authorization Prompt ID linked to the card.

• Driver Cards: Driver cards are issued to and remain with individual drivers, enabling the tracking of purchases and expenses specifically associated with that driver.

• Driver/Multi-Vehicle Card 1:M This card, carried by the driver, offers the flexibility to make purchases for multiple vehicles or assets. Although the Authorization Prompt ID identifies the specific vehicle or asset at the time of purchase, the system can track both the driver and the individual vehicle/asset involved in the transaction.

• Driver/Single-Vehicle Card 1:1 Plus This card is uniquely assigned to both a specific driver (with their individual Authorization Prompt ID) and a single vehicle for an extended timeframe.

• Driver Card 1:1 This card is assigned to a specific driver and functions similarly to a traditional debit card, requiring the driver to swipe the card and enter their unique Authorization Prompt ID (akin to a PIN) for authorization.

user_defined_fields - You can enter whatever information you want in these fields.

vehicle - You can only associate a vehicle with a card if it's a designated vehicle card (also referred to as an asset card). A vehicle card is defined by having a vehicle linked to it. There are three types of vehicle cards: 1:1, 1:many, and 1:1 plus. Notably, if you are using a 1:1 plus vehicle card, both a vehicle and a driver assignment are mandatory (See_Vehicle Cards_ for more information). You can enter the desired information in the provided fields but note that the Vehicle Identification Number (VIN) will undergo validation.

driver - The requirement for a driver association depends on the card's usage type. Driver cards necessitate the assignment of a driver, while "plus" cards require both a driver and a vehicle association. (See Driver Cards for more information).

prompt_id - The prompt_id is only required for 1:1 cards when it's customer-defined. For all 1:1 cards, the prompt_id is associated directly with the card entity. For instance, on a 1:1 vehicle card, you would enter a vehicle-specific prompt, and on a 1:1 driver card, you would enter a driver-specific prompt.

card_order - Is optional. If you leave it empty, the system will automatically use the default shipping information configured for the account. However, if you provide any data in this field, the system will attempt to map and use that information.

• requested_by - Is optional. If you provide information in this field, WEX will use it to identify who made the request. If you leave this field blank, WEX will automatically use your client ID.

• requested_by - Is optional. If you provide information in this field, WEX will use it to identify who made the request. If you leave this field blank, WEX will automatically use your client ID.

• address_type - The address_type field determines the kind of shipping address being used for the order, which affects how the address information is processed. If you choose SPECIALas the address_type , you are required to fill out all the address fields provided.

  • SPECIAL address - Selecting the SPECIALaddress type means you are providing a temporary shipping address. This address will only be used for this single card order and will not be saved, stored, or used for any subsequent orders.

  • ADMIN, MAILING, BILLING - When ordering a card, you can select ADMIN, MAILING, or BILLINGto use one of the addresses already associated with your account. Choosing ADMIN will ship the card to the address on file.

  • CARD_SHIPPING - The default address for every account. If you do not enter any address, the API will automatically ship the card to the address on file.

  • CARD ADDRESS - You can designate a specific shipping address for an individual card using CARD ADDRESS. When a card is ordered, and if the relevant account flag is active, the system will automatically use this card-specific address for shipment.

shipping_information - The shipping_information section defines the card's shipping destination. You should only provide address details here if you have chosen the SPECIALaddress type. For all other shipping options (like ADMIN, MAILING, BILLING, address input in this section is unnecessary. The following three fields within shipping_information are mandatory:

• carrier name - All cards are shipped using USPS by default. Specify an alternative carrier if needed.

• shipping_method - You must select the shipping method.

• use_customer_shipping - You must select this boolean.