API explorer
Fleet Management API Beta

Sections

Theme switcher

Find accounts eligible for transferring a card.

Authentication

Bearer Token

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

TokenstringRequired

Header Parameters

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

$skipstring

An OData-formatted $skip string (the page offset)

Default value
0
$topstring

An OData formatted $top string (number of records to return per page)

Default value
25

Path Parameters

card-idstring Required

The id for the card

Min length
1

Response

200
Object

Accounts in the requester hierarchy with transfer eligibility flags.

Response Attributes

accountsarray Required

Show child attributes

400
Object

Invalid request body

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

The supplied user does not have access to the associated account(s)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

Invalid Id

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?

GET

/

Select
1

Response

Was this section helpful?