FundingSource

The client can DELETE, GET, PATCH, or POST funding source information. NOTE: You must have the ability to manage users.

Get Funding Source By ID Endpoint

Gets a single funding source by ID. NOTE: You must have the ability to manage users.

Request

GET	{root_url}/v{version}/fundingsources/getFundingSourceById

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source_id	int	ID of the funding source	REQUIRED
includeInactiveFundingSources	boolean	Include removed funding sources
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful; Status code and message returned.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Get Funding Sources Endpoint

The following sample response shows what a user would receive back for a request where the user only has a single funding source.

[
  "Data": [
    {
      "name": "000AAA",
      "account": "",
      "phone": "",
      "fax_number": "",
      "email": "",
      "is_payee": false,
      "address": {
        "address1": "123 main st",
        "address2": "",
        "city": "mesa",
        "state": "az",
        "zip": ""
      },
      "contact": {
        "primary_contact": {
          "first_name": "",
          "middle_name": "",
          "last_name": ""
        },
        "alternative_contact": {
          "first_name": "",
          "last_name": ""
        }
      },
      "options": {
        "mileage_charge_calculation_is_routed": true,
        "smartphone_options": {
          "require_passenger_signature_pickup": true,
          "require_passenger_signature_dropoff": false,
          "require_passenger_agreement": "",
          "require_driver_signature_pickup": false,
          "require_driver_signature_dropoff": false,
          "require_odometer": true,
          "display_cost_to_driver": false,
          "disable_display": false,
          "driver_cancel_deletes_charges": false
        },
        "other_options": {
          "copy_client_code_to_auth": false,
          "require_authorization": false
        }
      },
      "isActive": true
    }
]

Deactivate Funding Source By ID Endpoint

Deactivates an existing funding source. NOTE: You must have the ability to manage users.

Request

DELETE	{root_url}/v{version}/fundingsources/deactivateFundingSourceById

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source_id	int	ID of the funding source	REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful; Status code and message returned.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Deactivate Funding Source Endpoint

The following sample response shows what a user would receive back from the deactivate funding source endpoint.

[
  {
    "StatusCode": 200,
    "Message": "Funding Source [Test FS] has been successfully removed."
  }
]

Deactivate FundingSource Endpoint

Deactivates an existing funding source. NOTE: You must have the ability to manage users.

Request

DELETE	{root_url}/v{version}/fundingsource

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source_id	int	Name of the funding source to deactivate.	REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful; Status code and message returned.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Deactivate Funding Source Endpoint

The following sample response shows what a user would receive back from the deactivate funding source endpoint.

[
  {
    "StatusCode": 200,
    "Message": "Funding Source [Test FS] has been successfully removed."
  }
]

Get Funding Sources Endpoint

Request

GET	{root_url}/v{version}/fundingsources

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source_name	string	Funding source name. Provide to get the funding source with this name.	REQUIRED
includeInactiveFundingSources	boolean	Include removed funding sources
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful; Status code and message returned.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Get Funding Sources Endpoint

The following sample response shows what a user would receive back for a request where the user only has a single funding source.

[
  "Data": [
    {
      "name": "000AAA",
      "account": "",
      "phone": "",
      "fax_number": "",
      "email": "",
      "is_payee": false,
      "address": {
        "address1": "123 main st",
        "address2": "",
        "city": "mesa",
        "state": "az",
        "zip": ""
      },
      "contact": {
        "primary_contact": {
          "first_name": "",
          "middle_name": "",
          "last_name": ""
        },
        "alternative_contact": {
          "first_name": "",
          "last_name": ""
        }
      },
      "options": {
        "mileage_charge_calculation_is_routed": true,
        "smartphone_options": {
          "require_passenger_signature_pickup": true,
          "require_passenger_signature_dropoff": false,
          "require_passenger_agreement": "",
          "require_driver_signature_pickup": false,
          "require_driver_signature_dropoff": false,
          "require_odometer": true,
          "display_cost_to_driver": false,
          "disable_display": false,
          "driver_cancel_deletes_charges": false
        },
        "other_options": {
          "copy_client_code_to_auth": false,
          "require_authorization": false
        }
      },
      "isActive": true
    }
]

Update Funding Source Endpoint

Request

PATCH	{root_url}/v{version}/fundingsources

Parameter	Type	Description	Notes
Model	string	See model definition below	REQUIRED
Version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Model Definition

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source	-
.name	string	Funding Source Name	REQUIRED
.account	string
.phone	string
.fax_number	string
.email	string
.isPayee	boolean		REQUIRED
.address	-
..address1	string
..address2	string
..city	string
..state	string
..zip	string
.contact	-
..primary_contact	-
...first_name	string
...middle_name	string
...last_name	string
..alternative_contact	-
...first_name	string
...middle_name	string
...last_name	string
.options	-
..mileage_charge_calculation_is_routed	boolean
..smartphone_options	-
...require_passenger_signature_pickup	boolean
...require_passenger_signature_dropoff	boolean
...require_passenger_agreement	boolean
...require_driver_signature_pickup	boolean
...require_driver_signature_dropoff	boolean
...require_odometer	boolean
...display_cost_to_driver	boolean
...disable_display	boolean
...driver_cancel_deletes_charges	boolean
..other_options	-
...copy_client_code_to_auth	boolean
...require_authorization	boolean
.isActive	boolean

Expected Response Codes

Code	Description
200	Request was successful.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Funding Source Model Sample

{
  "api_key": "56e1015d588fgdpf448384b6b3a345dfgd564",
  "funding_source": {
    "name": "Test Funding Source",
    "account": "",
    "phone": "",
    "fax_number": "",
    "email": "",
    "is_payee": false,
    "address": {
      "address1": "123 Main St",
      "address2": "",
      "city": "Mesa",
      "state": "AZ",
      "zip": ""
    },
    "contact": {
      "primary_contact": {
        "first_name": "",
        "middle_name": "",
        "last_name": ""
      },
      "alternative_contact": {
        "first_name": "",
        "middle_name": "",
        "last_name": ""
      }
    },
    "options": {
      "mileage_charge_calculation_is_routed": true,
      "smartphone_options": {
        "require_passenger_signature_pickup": true,
        "require_passenger_signature_dropoff": true,
        "require_passenger_agreement": "",
        "require_driver_signature_pickup": true,
        "require_driver_signature_dropoff": true,
        "require_odometer": true,
        "display_cost_to_driver": true,
        "disable_display": true,
        "driver_cancel_deletes_charges": true
      },
      "other_options": {
        "copy_client_code_to_auth": true,
        "require_authorization": true
      }
    },
    "isActive": true
  }
}

Create Funding Source Endpoint

Request

POST	{root_url}/v{version}/fundingsources

Parameter	Type	Description	Notes
Model	string	See model definition below	REQUIRED
Version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Model Definition

Parameter	Type	Description	Notes
api_key	string		REQUIRED
funding_source	-
.name	string	Funding Source Name	REQUIRED
.account	string
.phone	string
.fax_number	string
.email	string
.isPayee	boolean		REQUIRED
.address	-
..address1	string
..address2	string
..city	string
..state	string
..zip	string
.contact	-
..primary_contact	-
...first_name	string
...middle_name	string
...last_name	string
..alternative_contact	-
...first_name	string
...middle_name	string
...last_name	string
.options	-
..mileage_charge_calculation_is_routed	boolean
..smartphone_options	-
...require_passenger_signature_pickup	boolean
...require_passenger_signature_dropoff	boolean
...require_passenger_agreement	boolean
...require_driver_signature_pickup	boolean
...require_driver_signature_dropoff	boolean
...require_odometer	boolean
...display_cost_to_driver	boolean
...disable_display	boolean
...driver_cancel_deletes_charges	boolean
..other_options	-
...copy_client_code_to_auth	boolean
...require_authorization	boolean
.isActive	boolean

Expected Response Codes

Code	Description
200	Request was successful.
401	User management is not allowed for this api_key.
403	The API key used does not have access to this resource.

Funding Source Model Sample

{
  "api_key": "56e1015d588fgdpf448384b6b3a345dfgd564",
  "funding_source": {
    "name": "Test Funding Source",
    "account": "",
    "phone": "",
    "fax_number": "",
    "email": "",
    "is_payee": false,
    "address": {
      "address1": "123 Main St",
      "address2": "",
      "city": "Mesa",
      "state": "AZ",
      "zip": ""
    },
    "contact": {
      "primary_contact": {
        "first_name": "",
        "middle_name": "",
        "last_name": ""
      },
      "alternative_contact": {
        "first_name": "",
        "middle_name": "",
        "last_name": ""
      }
    },
    "options": {
      "mileage_charge_calculation_is_routed": true,
      "smartphone_options": {
        "require_passenger_signature_pickup": true,
        "require_passenger_signature_dropoff": true,
        "require_passenger_agreement": "",
        "require_driver_signature_pickup": true,
        "require_driver_signature_dropoff": true,
        "require_odometer": true,
        "display_cost_to_driver": true,
        "disable_display": true,
        "driver_cancel_deletes_charges": true
      },
      "other_options": {
        "copy_client_code_to_auth": true,
        "require_authorization": true
      }
    },
    "isActive": true
  }
}