API Docs Version 1.1.18

What's New

POST /get-preview-form

Get Preview Form

POST /fraud-identification/email-auth-score

API to validate customer PII data

GET /configuration

Get Hubex Configuration

POST /configuration

Create Hubex Configurations

DELETE /configuration

Delete Hubex Configurations

PATCH /configuration

Update Hubex Configurations

POST /credit/check

Credit Check

GET /events/{event_id}

Get an event for specific id

GET /events

Get a list of all events

POST /email/send-waitlist-email

Waitlist Email

POST /email/send-feedback-submission-email

Feedback Submission

POST /email/send-abandoned-cart-email

Abandoned Cart Email

What's Deleted

POST /get-preview

Get Preview

DELETE /fraud-check/delete-expired-cache-data

Delete expired responses

What's Changed

POST /email/send-subscription-trial-email

Request:

Changed content type : application/json

New required properties:

• trial_email_detail

New optional properties:

• days
• days_left
• email
• full_name
• product_name

• Added property trial_email_detail (array)

  Items (object):

  • Property name (string)

  • Property email (string)

  • Property product_name (string)

  • Property days_left (string)

  • Property past_days (integer)

  • Property subscription_id (integer)

  • Property product_id (integer)

• Deleted property full_name (string)

• Deleted property email (string)

• Deleted property product_name (string)

• Deleted property days_left (string)

• Deleted property days (integer)

POST /set-dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_id (string)

    PEN Dealer ID Number

  • Added property error (object)

    Error Details

    • Property dsi_log_id (string)

      PEN value for internal use.

    • Property description (string)

      Error description.

    • Property error_code (string)

      Error code

  • Added property success (string)

    Success or Failed.

  • Deleted property a:DealerID (string)

    PEN Dealer ID Number

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details

POST /get-providers

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details.

  • Added property providers (object)

    Provider Information

    • Property provider (array)

      List of Providers

      Items (object):

      • Property provider_id (string)

        Provider Id.

      • Property name (string)

        Provider Name.

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details.

  • Deleted property a:Providers (object)

    Provider Information

POST /get-provider-products

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details

  • Added property products (object)

    Provider Products Information

    • Property product (array)

      List of Provider Products

      Items (object):

      • Property name (string)

        Product Name

      • Property product_id (string)

        Product Id

      • Property product_type (string)

        Product Type

      • Property provider_dealer_code_format (string)

        User friendly format for the provider dealer code.

      • Property provider_dealer_code_name (string)

        Provider’s name for PEN property: ProviderDealerCode. (e.g., Dealer Code, Dealer Id, Dealer Number)

      • Property provider_id (string)

        Provider Id

      • Property rating_methods (object)

        Determines if the Rating call is by VIN.

        • Property rating_method (string)

          Rating Method.

      • Property rating_properties (string)

        Rating Properties

      • Property reg_exp_validator (string)

        Reg. Expression Validator used to validate the provider dealer code.

      • Property validator_prompt (string)

        Validator Prompt can be used to help the user understand the provider dealer code format defined by the Regular Expression Validator.

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details

  • Deleted property a:Products (object)

    Provider Products Information

POST /get-dealer-products

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details

  • Added property dealer_products (object)

    Dealer Products Information

    • Property dealer_product (array)

      List of Dealer Products

      Items (object):

      • Property dealer_id (string)

        PEN Dealer Id.

      • Property product_id (string)

        PEN Product Id.

      • Property dealer_product_id (string)

        PEN Dealer Product Id.

      • Property provider_dealer_code (string)

        Provider Dealer Code.

      • Property provider_dealer_product_code (string)

        Provider Product Code.

      • Property contract_prefix (string)

        Contract number Prefix.

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details

  • Deleted property a:DealerProducts (object)

    Dealer Products Information

POST /set-dealer-fni-products

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details

  • Added property rating_methods (object)

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details

  • Deleted property a:RatingMethods (object)

POST /get-program-codes

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details.

  • Added property program_codes (object)

    • Property program_code (object)

      List of Program Codes receive from PEN.

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details.

  • Deleted property a:ProgramCodes (array)

    List of Program Codes receive from PEN.

POST /get-ratebook-codes

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details.

  • Added property rate_book_codes (object)

    • Property rate_book_code (object)

      List of Rate Book Codes receive from PEN.

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details.

  • Deleted property a:RateBookCodes (array)

    List of Rate Book Codes receive from PEN.

POST /get-dealer-surcharges

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property success (string)

    Success or Failed.

  • Added property error (object)

    Error Details.

  • Added property surcharges (object)

    List of Surcharges receive from PEN.

    • Property surcharge (object)

  • Added property car_status (string)

    CarStatus of “UNDEFINED�? means the Surcharge is offered regardless of CarStatus. Otherwise the Surcharge is offered only when the vehicle is new, used, used w/factory warranty remaining, or certified pre-owned

  • Deleted property a:Success (string)

    Success or Failed.

  • Deleted property a:Error (object)

    Error Details.

  • Deleted property a:Surcharges (array)

    List of Surcharges receive from PEN.

  • Deleted property a:CarStatus (string)

    CarStatus of “UNDEFINED�? means the Surcharge is offered regardless of CarStatus. Otherwise the Surcharge is offered only when the vehicle is new, used, used w/factory warranty remaining, or certified pre-owned

POST /get-filled-form

Request:

Changed content type : application/json

• Added property cobuyer (object)

  Vehicle details.

  • Property firstname (string)

    Co Buyer First Name

  • Property lastname (string)

    Co Buyer Last Name.

  • Property namesuffix (string)

    Co Buyer Name Suffix.

  • Property middleinitial (string)

    Co Buyer Middle Initial.

  • Property address1 (string)

    House address line 1 of this Co Buyer.

  • Property address2 (string)

    House address line 2 of this Co Buyer.

  • Property state (string)

    State of the Co Buyer.

  • Property city (string)

    City of the Co Buyer.

  • Property zipcode (string)

    Zip code of the Co Buyer city.

  • Property email (string)

    Email of the Co Buyer.

  • Property phonenumber (string)

    Phone number of the Co Buyer city.

• Added property lienholder (object)

  Lien Holder details

  • Property name (string)

    Lien Holder bank name

  • Property address1 (string)

    Bank Address Line 1

  • Property address2 (string)

    Bank Address Line 2

  • Property city (string)

    Bank City

  • Property state (string)

    Bank State.

  • Property zipcode (string)

    /Bank Zip Code

  • Property fax (string)

    Bank Fax Number.

  • Property phone (string)

    Bank Phone Number.

• Added property test_request (boolean)

  Is request for testing or support purposes?

• Changed property product (object)

  Pen product details.

  New optional properties:

  • cost
  • price
  • srp

• Changed property customer (object)

  Customer details.

  New optional properties:

  • address1

  • address2

  • city

  • state

  • Added property firstname (string)

    Customer First Name

  • Added property lastname (string)

    Customer Last Name.

  • Added property namesuffix (string)

    Customer Name Suffix.

  • Added property middleinitial (string)

    Customer Middle Initial.

  • Added property zipcode (string)

    Zip code of the customer city.

  • Added property email (string)

    Email of the Customer.

  • Added property businessphonenumber (string)

    Phone number of the customer city.

• Changed property deal (object)

  Order details.

  New optional properties:

  • dealtype
  • effectivedate
  • fimanagername
  • financedamount
  • financeterm
  • monthlypayment
  • order_id

• Changed property vehicle (object)

  Vehicle details.

  New required properties:

  • vin

  New optional properties:

  • carstatus

  • inservicedate

  • modelyear

  • odometer

  • purchaseprice

  • Added property vin (string)

    Vin number of this vehicle

  • Added property make (string)

    Make of this vehicle.

  • Added property model (string)

    Model of this vehicle.

  • Added property msrp (string)

    MSRP of this vehicle

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /void-contract

Request:

Changed content type : application/json

New optional properties:

• contract_number
• deal_identifier
• deal_number
• form_id
• pen_dealer_id
• voided_by

POST /tradein/get-tradein-modelyears

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all models will be returned

  • Deleted property makeName (string)

    Limit the output to only those models Name available for the specific make name.

  • Deleted property modelName (string)

    Limit the output to only those models Name available for the specific model name.

  • Changed property makeId (integer)

    Limits the output to only those model years available for the specified make.

  • Changed property yearId (integer)

    Limits the output to only those model years available for the specified year.

  • Changed property modelId (integer)

    Limits the output to only those model years available for the specified model.

POST /tradein/get-tradein-vehicle

Return Type:

Changed response : 201 Created

Successful

• Changed content type : application/json

  New optional properties:

  • generationEndYear

  • generationId

  • generationInstanceId

  • generationName

  • generationSequence

  • generationStartYear

  • oemBodyStyle

  • originalMSRP

  • standardDrivetrain

  • standardEngine

  • standardTransmission

  • category

  • categoryCode

  • cc

  • cylinders

  • invoice

  • msrp

  • stroke

  • tradeIn

  • Changed property items (array)

    Changed items (object):

    New optional properties:

    • category
    • categoryCode
    • cc
    • cylinders
    • invoice
    • msrp
    • stroke
    • tradeIn

POST /payment/payment-intents

Parameters:

Added: x-api-version in header

Request:

Changed content type : application/json

• Added property source (string)

  The payment description for this PaymentIntent.

• Added property expires_at (string)

  The date for which payment will expire for this PaymentIntent.

• Added property application_fee_amount (integer)

  The amount of the application fee to be applied to the payment.

• Added property return_url (string)

  The return url after the payment is done.

• Added property shipping_address (object)

  The shipping address of the user.

• Added property billing_address (object)

  The billing address of the user.

  • Property country (string)

  • Property email (string)

  • Property first_name (string)

  • Property last_name (string)

  • Property address (string)

  • Property address2 (string)

  • Property city (string)

  • Property phone (string)

  • Property state (string)

  • Property zip (string)

  • Property county (string)

• Added property amount_breakdown (object)

  The amount breakdown items.

• Added property items (object)

  The items list for this PaymentIntent.

• Changed property capture_method (string)

  Controls when the funds will be captured from the customer’s account. Possible values automatic and manual.

• Changed property payment_method_type (string)

  The payment method type that this PaymentIntent is allowed to use. e.g. card, us_bank_account.

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property amount_details (object)

    Details about items included in the amount.

  • Added property payment_method_type (string)

    Payment method type of the payment, e.g. card, us_bank_account

  • Deleted property automatic_payment_methods (object)

    Settings to configure compatible payment methods from the Stripe Dashboard.

  • Deleted property charges (object)

    Charges that were created by this PaymentIntent, if any.

  • Deleted property last_payment_error (object)

    The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

  • Deleted property payment_method_types (array)

    The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

  • Deleted property receipt_email (string)

    Email address that the receipt for the resulting payment will be sent to.

  • Deleted property setup_future_usage (string)

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

  • Deleted property shipping (object)

    Shipping information for this PaymentIntent.

  • Deleted property statement_descriptor (string)

    For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

  • Deleted property statement_descriptor_suffix (string)

    Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

  • Deleted property application (string)

    ID of the Connect application that created the PaymentIntent.

  • Deleted property canceled_at (integer)

    Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

  • Deleted property cancellation_reason (string)

    Reason for cancellation of this PaymentIntent.

  • Deleted property confirmation_method (string)

    An enumeration.

  • Deleted property invoice (string)

    ID of the invoice that created this PaymentIntent, if it exists.

  • Deleted property created (string)

    Time at which the account was connected. Measured in seconds since the Unix epoch.

  • Deleted property livemode (boolean)

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • Deleted property on_behalf_of (string)

    The account (if any) for which the funds of the PaymentIntent are intended.

  • Deleted property payment_method_options (object)

    Payment-method-specific configuration for this PaymentIntent.

  • Deleted property processing (object)

    If present, this property tells you about the processing state of the payment.

  • Deleted property review (string)

    ID of the review associated with this PaymentIntent, if any.

  • Deleted property transfer_data (object)

    The data with which to automatically create a Transfer when the payment is finalized.

  • Deleted property transfer_group (string)

    A string that identifies the resulting payment as part of a group.

  • Changed property amount (integer -> number)

    Amount intended to be collected by this PaymentIntent.

  • Changed property client_secret (string)

    The client secret of this PaymentIntent

  • Changed property metadata (object)

    Set of key-value pairs that you can attach to an object.

  • Changed property application_fee_amount (integer)

    The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s account.

  • Changed property capture_method (string)

    Controls when the funds will be captured from the customer’s account. Possible values automatic and manual.

    Removed enum values:

    • automatic
    • manual

POST /get-rates

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property rates (object)

    • Property rate (object)

  • Deleted property a:Rates (object)

POST /tradein/get-tradein-vehiclevalue

Return Type:

Changed response : 201 Created

Successful

• Changed content type : application/json

  • Changed property prices (array)

    Changed items (object):

    New optional properties:

    • condition

    • configuredValue

    • mileageAdjustment

    • optionAdjustment

    • priceTypeDisplay

    • priceTypeId

    • rangeHigh

    • rangeLow

    • Changed property optionPrices (array)

      Changed items (object):

      New optional properties:

      • price
      • removalAdjustment
      • vehicleOptionId