API Reference

/cards/{card_id}

get https://api.keeptruckin.com/motive_card/v1/cards/

Purpose: View detailed info of a particular Motive Card. This endpoint fetches details such as display_card_id, status, last_transaction_performed_at, security_settings, spend_control_profile, and vehicle_proximity_based_decline_settings.

Response Parameters

cards

  • Type: Array of Objects
  • Description: Contains a list of card objects.

id

  • Type: String (UUID)
  • Description: The unique identifier of the card.

last_four_digits

  • Type: String
  • Description: The last four digits of the card number.

display_card_id

  • Type: String
  • Description: A display-friendly identifier for the card.

name_line_1

  • Type: String
  • Description: The first line of the cardholder’s name (e.g., driver name).

name_line_2

  • Type: String
  • Description: The second line of the cardholder’s name (e.g., company name).

status

  • Type: String
  • Description: The current status of the card (e.g., active).

created_at

  • Type: String (DateTime)
  • Description: The timestamp indicating when the card was created.

updated_at

  • Type: String (DateTime)
  • Description: The timestamp indicating when the card information was last updated.

assigned_to

  • Type: Object
  • Description: Information about the entity (e.g., driver) to whom the card is assigned.

entity_type

  • Type: String
  • Description: The type of entity to which the card is assigned (e.g., driver).

entity_id

  • Type: Integer
  • Description: The unique identifier of the assigned entity.

entity_name

  • Type: String
  • Description: The name of the assigned entity.

security_settings

  • Type: Object
  • Description: Security-related settings for the card.

status

  • Type: String
  • Description: The security status of the card (e.g., active).

is_locked

  • Type: Boolean
  • Description: Indicates if the card is currently locked.

unlocked_till

  • Type: String (DateTime) or null
  • Description: The time until which the card remains unlocked, if applicable.

vehicle_proximity_based_decline_settings

  • Type: Boolean
  • Description: Whether vehicle proximity-based declines are enabled or not.

spend_control_profile

  • Type: Object
  • Description: Contains the spending control profile details for the card.

id

  • Type: String (UUID)
  • Description: The unique identifier of the spend control profile.

name

  • Type: String
  • Description: The name of the spend control profile.

is_default

  • Type: Boolean
  • Description: Indicates if this profile is the default profile.

created_at

  • Type: String (DateTime)
  • Description: The timestamp when the profile was created.

updated_at

  • Type: String (DateTime)
  • Description: The timestamp when the profile was last updated.

spend_limits

  • Type: Object
  • Description: Detailed spending limits set within the profile.

daily_limit_in_cents

  • Type: Integer or null
  • Description: The daily spending limit in cents.

weekly_limit_in_cents

  • Type: Integer or null
  • Description: The weekly spending limit in cents.

monthly_limit_in_cents

  • Type: Integer or null
  • Description: The monthly spending limit in cents.

transaction_limit_in_cents

  • Type: Integer or null
  • Description: The per-transaction spending limit in cents.

billing_cycle_spend_limit_in_cents

  • Type: Integer or null
  • Description: The spending limit for the current billing cycle in cents.

daily_withdrawal_limit_in_cents

  • Type: Integer or null
  • Description: The daily withdrawal limit in cents (e.g., at ATMs).

weekly_withdrawal_limit_in_cents

  • Type: Integer or null
  • Description: The weekly withdrawal limit in cents.

atm_withdrawal_enabled

  • Type: Boolean
  • Description: Indicates whether ATM withdrawals are allowed.

enable_days

  • Type: Array of Strings
  • Description: The days of the week when the card can be used (e.g., ["mon", "tue", ...]).

enable_start_time

  • Type: String (Time)
  • Description: The start time (in 24-hour format) from which card usage is enabled.

enable_end_time

  • Type: String (Time)
  • Description: The end time (in 24-hour format) until which card usage is enabled.

created_by

  • Type: Integer or null
  • Description: The ID of the user who created these spend limits.

spend_categories

  • Type: Array of Strings
  • Description: The spending category for this profile (e.g., ["Fuel pump"]).
Language
Credentials
Header
Click Try It! to start a request and see the response here!