API Docs Version 1.1.50

What's New

POST /payment/invoices/search-by-metadata

Search Invoices by metadata

POST /payment/invoices/upcoming

Upcoming Invoices

GET /payment/charges

Get payment charges

POST /dms/customers

Create Customer

GET /dms/customers/search

Search Customer

GET /dms/customers/{customer_id}

Get Customer

PUT /dms/customers/{customer_id}

Update Customer

GET /dms/inventory

Get Vehicle Inventory

PUT /dms/inventory

Update Vehicle Inventory

POST /dms/inventory

Create Vehicle Inventory

GET /dms/deals

Get Deals

POST /dms/deals

Create Deal

POST /dms/leads

Create Lead

GET /dms/leads/search

Search Leads

GET /dms/leads/{customer_id}

Get Elead Customer

PATCH /dms/leads/{customer_id}

Update Lead

What's Changed

POST /stripe/subscription

Request:

Changed content type : application/json

• Added property trial_end (integer)

POST /configuration

Request:

Changed content type : application/json

• Changed property account_verification (object)

  Configuration for the Account Verification

  • Deleted property account_verification_service (object)

    Customer Default Account Verification Service

  • Changed property plaid (object)

    Plaid Configuration

    • Changed property client_secret (string)

      The secret key provided by Plaid for authenticating API requests.

    • Changed property client_id (string)

      The client identifier provided by Plaid, uniquely identifying your application.

    • Changed property client_app_name (string)

      The name of your application as it should appear in Plaid's Link interface.

    • Changed property client_webhook (string)

      The URL where Plaid will send webhook notifications for events related to your application.

    • Changed property api_url (string)

      The base URL for accessing the Plaid API, including both Sandbox and Production environments.

    • Changed property api_version (string)

      The version of the Plaid API to be used for processing requests. Example: 2022-03-16

• Changed property fraud_identification (object)

  Configuration for Fraud Identification

  • Deleted property fraud_identification_service (object)

    Fraud Identification Gateway

• Changed property credit_application (object)

  Configuration for Credit Application

  • Deleted property credit_service (string)

    Customer Default Credit Service

  • Changed property transunion (object)

    TransUnion Configuration

    New required properties:

    • certificate_file

    • Added property certificate_file (string)

      The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

      • Open this link: https://base64.guru/converter/encode/file (opens in a new tab).
      • Select and upload file of certificate.
      • Click on Encode file to Base64.
      • Retrieve the complete base64 string from the base64 text box.
      • Paste this certificate string in the certificate file field of the request body schema.

      Improve: "Send a request to the configuration endpoint of Hubex."

      • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
      • Now you can utilize the TransUnion third-party service.

• Changed property vehicle_valuation (object)

  Configuration for Vehicle Valuation

  • Deleted property vehicle_valuation_service (object)

    Vehicle Valuation Gateway

• Changed property dealer_management_system (object)

  Configuration for dms

  • Changed property cdk (object)

    CDK configuration

    New optional properties:

    • api_key

    • api_secret

    • api_url

    • department_id

    • subscription_id

    • Added property customer_api (object)

      Cdk Customer Api configuration

      • Property api_url (string)

        API base URL

      • Property subscription_id (string)

        Subscription identifier between a user entity and the app

      • Property api_key (string)

        API key

      • Property api_secret (string)

        API secret

      • Property department_id (string)

        Accounting Department Id of Store

    • Added property deal_api (object)

      Cdk Deal Api configuration

    • Added property elead_customer_api (object)

      Cdk Elead Customer Api configuration

    • Deleted property subscription_id (string)

      Subscription identifier between a user entity and the app

    • Deleted property api_key (string)

      API key

    • Deleted property api_secret (string)

      API secret

    • Deleted property department_id (string)

      Accounting Department Id of Store

    • Deleted property api_url (string)

      API base URL

• Changed property license_verification (object)

  Configuration for License Verification

  • Added property facephi (object)

    FacePhi account integration

    • Property base_url (string)

      FacePhi Base API url (Sandbox or Production)

    • Property api_key (string)

      FacePhi Credentials - Authorization to access the API

  • Deleted property license_verification_service (object)

    License Verification Gateway

  • Deleted property idnow (object)

    IdNow account integration

  • Changed property mitek (object)

    Mitek account integration

    • Changed property verification_matrix (object)

      Mitek Verification Matrix

      • Changed property verifications (array)

        Verification List for Mitek Account

        Changed items (object):

        New required properties:

        • action

        • mitek_verification_type

        • Changed property mitek_verification_type (integer -> integer)

          An enumeration.

        • Changed property mitek_judgement (string -> string)

          An enumeration.

        • Changed property action (string -> string)

          An enumeration.

• Changed property payment (object)

  Configuration for the Payment

  • Deleted property payment_service (object)

    Customer Default Payment Service

  • Changed property nuvei (object)

    Represents the configuration settings required for integrating with Nuvei payment gateway services.

    • Changed property merchant_id (string)

      The unique merchant identifier is provided by Nuvei for authentication and identification purposes.

    • Changed property merchant_site_id (string)

      The merchant site identifier provided by Nuvei, which associates the transaction with a specific merchant site or account.

    • Changed property merchant_secret_key (string)

      The secret key is provided by Nuvei for secure communication and authentication of API requests.

    • Changed property api_url (string)

      The base URL for accessing the Nuvei API, including both Sandbox and Production environments. This URL is used for making API requests.

  • Changed property stripe (object)

    Represents the configuration settings required for integrating with Stripe payment gateway services.

    • Changed property api_key (string)

      The API key is required for authenticating requests to the Stripe API. This key grants access to your Stripe account and authorizes interactions with the API endpoints. Example: sk_test_1234567890

    • Changed property api_version (string)

      The version of the Stripe API to be used for processing requests. Stripe regularly releases updates and introduces new features, and specifying the API version ensures compatibility and consistency in API interactions. Example: 2022-03-16

    • Changed property web_hooks (array)

      An array containing objects representing webhook configurations. Webhooks are HTTP callbacks triggered by events that occur in your Stripe account, such as successful charges or failed payments. Each webhook object includes details about the webhook URL and the events it is configured to listen to. Example: { 'url': 'https://example.com/stripe-webhook', 'events': ['account.updated']}

PATCH /configuration

Request:

Changed content type : application/json

• Changed property account_verification (object)

  Configuration for the Account Verification

  • Deleted property account_verification_service (object)

    Customer Default Account Verification Service

  • Changed property plaid (object)

    Plaid Configuration

    • Changed property client_secret (string)

      The secret key provided by Plaid for authenticating API requests.

    • Changed property client_id (string)

      The client identifier provided by Plaid, uniquely identifying your application.

    • Changed property client_app_name (string)

      The name of your application as it should appear in Plaid's Link interface.

    • Changed property client_webhook (string)

      The URL where Plaid will send webhook notifications for events related to your application.

    • Changed property api_url (string)

      The base URL for accessing the Plaid API, including both Sandbox and Production environments.

    • Changed property api_version (string)

      The version of the Plaid API to be used for processing requests. Example: 2022-03-16

• Changed property fraud_identification (object)

  Configuration for Fraud Identification

  • Deleted property fraud_identification_service (object)

    Fraud Identification Gateway

• Changed property credit_application (object)

  Configuration for Credit Application

  • Deleted property credit_service (string)

    Customer Default Credit Service

  • Changed property transunion (object)

    TransUnion Configuration

    New required properties:

    • certificate_file

    • Added property certificate_file (string)

      The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

      • Open this link: https://base64.guru/converter/encode/file (opens in a new tab).
      • Select and upload file of certificate.
      • Click on Encode file to Base64.
      • Retrieve the complete base64 string from the base64 text box.
      • Paste this certificate string in the certificate file field of the request body schema.

      Improve: "Send a request to the configuration endpoint of Hubex."

      • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
      • Now you can utilize the TransUnion third-party service.

• Changed property vehicle_valuation (object)

  Configuration for Vehicle Valuation

  • Deleted property vehicle_valuation_service (object)

    Vehicle Valuation Gateway

• Changed property dealer_management_system (object)

  Configuration for dms

  • Changed property cdk (object)

    CDK configuration

    New optional properties:

    • api_key

    • api_secret

    • api_url

    • department_id

    • subscription_id

    • Added property customer_api (object)

      Cdk Customer Api configuration

    • Added property deal_api (object)

      Cdk Deal Api configuration

    • Added property elead_customer_api (object)

      Cdk Elead Customer Api configuration

    • Deleted property subscription_id (string)

      Subscription identifier between a user entity and the app

    • Deleted property api_key (string)

      API key

    • Deleted property api_secret (string)

      API secret

    • Deleted property department_id (string)

      Accounting Department Id of Store

    • Deleted property api_url (string)

      API base URL

• Changed property license_verification (object)

  Configuration for License Verification

  • Added property facephi (object)

    FacePhi account integration

  • Deleted property license_verification_service (object)

    License Verification Gateway

  • Deleted property idnow (object)

    IdNow account integration

  • Changed property mitek (object)

    Mitek account integration

    • Changed property verification_matrix (object)

      Mitek Verification Matrix

      • Changed property verifications (array)

        Verification List for Mitek Account

        Changed items (object):

        New required properties:

        • action

        • mitek_verification_type

        • Changed property mitek_verification_type (integer -> integer)

          An enumeration.

        • Changed property mitek_judgement (string -> string)

          An enumeration.

        • Changed property action (string -> string)

          An enumeration.

• Changed property payment (object)

  Configuration for the Payment

  • Deleted property payment_service (object)

    Customer Default Payment Service

  • Changed property nuvei (object)

    Represents the configuration settings required for integrating with Nuvei payment gateway services.

    • Changed property merchant_id (string)

      The unique merchant identifier is provided by Nuvei for authentication and identification purposes.

    • Changed property merchant_site_id (string)

      The merchant site identifier provided by Nuvei, which associates the transaction with a specific merchant site or account.

    • Changed property merchant_secret_key (string)

      The secret key is provided by Nuvei for secure communication and authentication of API requests.

    • Changed property api_url (string)

      The base URL for accessing the Nuvei API, including both Sandbox and Production environments. This URL is used for making API requests.

  • Changed property stripe (object)

    Represents the configuration settings required for integrating with Stripe payment gateway services.

    • Changed property api_key (string)

      The API key is required for authenticating requests to the Stripe API. This key grants access to your Stripe account and authorizes interactions with the API endpoints. Example: sk_test_1234567890

    • Changed property api_version (string)

      The version of the Stripe API to be used for processing requests. Stripe regularly releases updates and introduces new features, and specifying the API version ensures compatibility and consistency in API interactions. Example: 2022-03-16

    • Changed property web_hooks (array)

      An array containing objects representing webhook configurations. Webhooks are HTTP callbacks triggered by events that occur in your Stripe account, such as successful charges or failed payments. Each webhook object includes details about the webhook URL and the events it is configured to listen to. Example: { 'url': 'https://example.com/stripe-webhook', 'events': ['account.updated']}