API explorer
Fleet Management API Beta

Sections

Theme switcher

Create a new bank.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

user_idstring

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.

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Query Parameters

account_idstring Required
Min length
1

Body Parameters

bank_account_namestring Required

Name of the banking institution

Max length
50
bank_account_numberstring Required

Account number of the bank to be used for payments.

Max length
20
bank_routing_numberstring Required

Routing number of the bank to be used for payments.

Max length
9
default_bankboolean

Identifies if the bank is the default bank to use.

Default value
false

Response

201
Object

Bank account information.

Response Attributes

_linksobject

HATEOAS links to bank-related resources

Show child attributes

bank_account_last_four_digitsstring

Last four digits of the bank account number.

bank_account_namestring

Name of the banking institution

Max length
50
bank_account_statusstring

Indicates if the bank account is Active, Inactive or Pending.

Enum values:
ACTIVEDELETEDINACTIVEPENDINGNONE
bank_idinteger

Unique identifier for the bank.

bank_routing_numberstring

Routing number of the bank to be used for payments.

Max length
9
default_bankboolean

Identifies if the bank is the default bank to use.

Default value
false
400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?