Accounts
This section provides a detailed overview of the Fleet Service API’s accounts operational logic.
revolver_account: Refers to revolving credit.
billing:
- Cycle: We provide various billing cycles. The cycle assigned to your account is determined by your monthly billing statement date.
card_info:
- wexaccountnumber: This field represents your internal account number, and it is different from your card number.
- renewal_period: Specifies the interval at which WEX issues replacement cards.
cardshippinginfo:
- shippingcompanyname: WEX will use this company name on all mail sent to you.
- shippingproductid: This allows you to choose between overnight and regular shipping options.
- allowcardlevel_shipping: Enables shipping cards to the address on the card.
customization:
- alias:This corresponds to your account’s short name, also known as your “doing business as” (DBA) name.
- reports:
- customftpaccount: This specifies the account to which your reports will be sent using FTP.
- customftpserver: This specifies the server to which your reports will be sent.
- reportsubtotal_type: The type of report you will receive.
vehicle_info:
- vehicleidlength: The vehicle prompt length.
- driveridlength: The driver prompt length, typically 4 - 6 digits.
- hascustomerassigneddriverid: If you are creating cards and using customer-assigned IDs, you can provide your own driver prompt IDs. However, if the system-assigned ID option is enabled (boolean is false), the driver prompt IDs will be system-generated, and you do not need to enter any.
- hascustomerassignedvehicleid: If you are creating cards and using customer-assigned IDs, you can provide your own driver prompt IDs. However, if the system-assigned ID option is enabled (boolean is false), the driver prompt IDs will be system-generated, and you do not need to enter any.
- association_root: This is a WEX internal field.
- financiallyliableaccount_number: If you are the financially liable account holder, you are responsible for paying all charges incurred by any of your child entities.
- funder: The funder is the entity that covers the expenses until you make payment. Typically, this is WEX.
- Id: Your internal Id.
- parentaccountid: The parent Id in the hierarchy.
- short_name: This is a shorter version of your account’s name.
- ultimateparentaccount_id: In your account hierarchy, this is the highest-level account. Many configurations, such as EV settings, are typically applied at this level and then inherited by all child accounts.
balance:
- balance: Account balance, not including any pending transactions.
- opentobuy_balance: Represents the current amount of credit available for making purchases.
balance_config:
- direct_debit: WEX directly debits the customer’s bank account for payment.
- distributor: A distributor manages multiple service stations (often with various brands) and may also distribute other petroleum products like heating oil and lubricants.
- funded: WEX Bank provides funding and servicing for this card program and is responsible for managing receivables and assuming credit risk on its fleet accounts.
- account_number: The WEX-assigned external account number, also called the Program Account Number.
- account_status: Pending, Active, Suspended, Terminated
- scheduledbankid: Identifies the bank from which the money will be drawn.
card_profile: Creating a card requires your card_profile_id . This profile defines the card’s characteristics, such as embossing details (location, lines), logos, and swipe prompts.
usage_type: See the business rules outlined earlier in Appendix A - Cards.
Was this section helpful?
On this page
- Accounts