API Docs Version 1.1.11

What's New

GET /api-version

Get Hubex API Version

POST /tradein/get-tradein-modelyears

Model Years

POST /tradein/get-tradein-vehicle

Vehicle Detail

POST /tradein/get-tradein-vehiclevalue

Vehicle Value

POST /payment/webhooks

Handle payment webhooks

POST /payment/invoices/upcoming/lines

Upcoming Line Items

What's Deleted

POST /get-template

Get Template

POST /tradein/get-tradein-vehicleValue

Vehicle Value

POST /payment/payment/webhooks

Handle payment webhooks

POST /payment/invoices/upcoming/line

Upcoming Line Items

What's Changed

POST /get-program-codes

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property a:ProgramCodes (array)

    List of Program Codes receive from PEN.

    Changed items (object):

    • Added 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-ratebook-codes

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property a:RateBookCodes (array)

    List of Rate Book Codes receive from PEN.

    Changed items (object):

    • Added 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-dealer-surcharges

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property a:Surcharges (array)

    List of Surcharges receive from PEN.

    Changed items (object):

    • Added 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

New required properties:

• customer
• deal
• product
• vehicle

New optional properties:

• form_id
• order_id
• pen_dealer_id
• pen_product_id
• rate_id
• session_id

• Added property product (object)

  Pen product details.

  • Property pen_dealer_id (integer)

    PEN Dealer Id number.

  • Property pen_product_id (integer)

    Product Id to rate.

  • Property form_id (integer)

    Dealer's form id for this product.

  • Property rate_id (integer)

    Dealer's rate id for this product.

  • Property session_id (string)

    Dealer's session id for this product.

  • Property price (string)

    Price for this product.

  • Property cost (string)

    Cost for this product.

  • Property srp (string)

    SRP for this product.

• Added property customer (object)

  Customer details.

  • Property state (string)

    State of the customer.

  • Property address1 (string)

    House address line 1 of this customer.

  • Property address2 (string)

    House address line 2 of this customer.

  • Property city (string)

    City of the customer.

• Added property deal (object)

  Order details.

  • Property order_id (string)

    Order id of this product.

  • Property effectivedate (string)

    Date of the deal.

  • Property financedamount (string)

    Financed amount of the deal.

  • Property financeterm (string)

    Terms of the deal.

  • Property apr (string)

    APR of the deal.

  • Property monthlypayment (string)

    Montlt payment for the customer.

  • Property dealtype (string)

    Deal type of this deal.

  • Property fimanagername (string)

    dealer name.

• Added property vehicle (object)

  Vehicle details.

  • Property modelyear (string)

    Model year of this vehicle.

  • Property odometer (integer)

    Odometer reading of this vehicle.

  • Property inservicedate (string)

    Inservice date of this vehicle.

  • Property carstatus (string)

    Status of this vehicle.

  • Property purchaseprice (string)

    Purchase price of this vehicle.

• Deleted property pen_dealer_id (integer)

  PEN Dealer Id number.

• Deleted property pen_product_id (integer)

  Product Id to rate.

• Deleted property form_id (integer)

  Dealer's form id for this product.

• Deleted property rate_id (integer)

  Dealer's rate id for this product.

• Deleted property session_id (string)

  Dealer's session id for this product.

• Deleted property order_id (string)

  Order id of this product.

POST /get-preview

Request:

Changed content type : application/json

New required properties:

• customer
• deal
• product
• vehicle

New optional properties:

• form_id
• order_id
• pen_dealer_id
• pen_product_id
• rate_id
• session_id

• Added property product (object)

  Pen product details.

• Added property customer (object)

  Customer details.

• Added property deal (object)

  Order details.

• Added property vehicle (object)

  Vehicle details.

• Deleted property pen_dealer_id (integer)

  PEN Dealer Id number.

• Deleted property pen_product_id (integer)

  Product Id to rate.

• Deleted property form_id (integer)

  Dealer's form id for this product.

• Deleted property rate_id (integer)

  Dealer's rate id for this product.

• Deleted property session_id (string)

  Dealer's session id for this product.

• Deleted property order_id (string)

  Order id of this product.

POST /tradein/get-tradein-years

Request:

Changed content type : application/json

• Added property filter (object)

  If not specified, all years will be returned

  • Property makeId (integer)

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

  • Property modelId (integer)

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

  • Property makeName (string)

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

  • Property modelName (string)

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

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

POST /tradein/get-tradein-makes

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all makes will be returned

  • Deleted property makeName (string)

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

  • Deleted property modelId (integer)

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

  • Deleted property modelName (string)

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

  • Changed property yearId (integer)

    Limits the output to only those makes available for the specified year.

  • Changed property makeId (integer)

    Limits the output to only those makes available for the specified make.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

  New required properties:

  • makeId
  • makeName

  New optional properties:

  • items

  • items

  • Added property makeId (integer)

    Vehicle Make Id.

  • Added property makeName (string)

    Vehicle Make Name.

POST /tradein/get-tradein-models

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all models will be returned

  • Deleted property modelName (string)

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

  • Changed property yearId (integer)

    Limits the output to only those makes available for the specified year.

  • Changed property makeId (integer)

    Limits the output to only those makes available for the specified make.

  • Changed property makeName (string)

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

  • Changed property modelId (integer)

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

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

POST /tradein/get-tradein-trims

Request:

Changed content type : application/json

New required properties:

• platform_vehicle_type

• Added property platform_vehicle_type (object)

  NewCar or UsedCar. If not specified, all records will be returned.

  Enum values:

  • Car
  • NewCar
  • UsedCar

• Changed property filter (object)

  YearId, MakeId, ModelId are mandatory for trim request

  New required properties:

  • makeId

  • modelId

  • yearId

  • Added property trimId (integer)

    Limits the output to only those trims available for the specified trim id

  • Added property modelYearId (integer)

    Limits the output to only those trims available for the specified model year

  • Deleted property makeName (string)

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

  • Deleted property modelName (string)

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

  • Changed property yearId (integer)

    Limits the output to only those Trims available for the specified year.

  • Changed property makeId (integer)

    Limits the output to only those Trims available for the specified make.

  • Changed property modelId (integer)

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

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

POST /tradein/get-tradein-allOptions

Request:

Changed content type : application/json

• Changed property platform_vehicle_type (string)

  An enumeration.

  Removed enum value:

  • MotorBike

• Changed property filter (object)

  • Deleted property makeName (string)

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

  • Deleted property modelName (string)

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

  • Changed property vehicleId (integer)

    Vehicle Id match will be returned

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

  New required properties:

  • vehicleId

  • Changed property items (array)

    Changed items (object):

    New required properties:

    • hasRelationships
    • isConfigurable
    • isConsumer
    • isTypical
    • sortOrder
    • vehicleId

DELETE /payment/subscriptions/{subscription_id}

Parameters:

Added: invoice_now in query

Added: prorate in query

POST /payment/invoices

Request:

Changed content type : application/json

• Added property reference (string)

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

• Added property term (string)

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

• Added property memo (string)

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

• Added property payment_term (object)

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

• Added property session_token (string)

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

• Added property merchant_id (string)

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

• Added property ip_address (string)

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

• Added property user_token_id (string)

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

• Added property card_number (string)

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

• Added property card_holder_name (string)

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

• Added property expiration_month (string)

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

• Added property expiration_year (string)

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

• Added property cvv (string)

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

• Added property method_notification_url (string)

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

• Added property platform_fee (string)

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

• Added property return_uri (string)

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

• Added property source (string)

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

• Added property zero_interest_installments (string)

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

PATCH /payment/invoices/{invoice_id}

Request:

Changed content type : application/json

• Added property reference (string)

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

• Added property term (string)

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

• Added property memo (string)

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

• Added property payment_term (object)

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

• Added property session_token (string)

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

• Added property merchant_id (string)

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

• Added property ip_address (string)

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

• Added property user_token_id (string)

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

• Added property card_number (string)

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

• Added property card_holder_name (string)

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

• Added property expiration_month (string)

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

• Added property expiration_year (string)

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

• Added property cvv (string)

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

• Added property method_notification_url (string)

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

• Added property platform_fee (string)

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

• Added property return_uri (string)

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

• Added property source (string)

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

• Added property zero_interest_installments (string)

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

POST /get-rates

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-decodevin

Request:

Changed content type : application/json

• Added property optionFilter (object)

  Enum values:

  • All
  • DecodedOnly

• Changed property vin (string)

  Vehicle identification number

Return Type:

New response : 400 Bad Request

Bad Request

New response : 401 Unauthorized

UnAuthorized Request

New response : 404 Not Found

Record not found

Changed response : 201 Created

Successful

• Changed content type : application/json

  • Changed property vinResults (array)

    Changed items (object):

    New required properties:

    • bodyStyle

    • doors

    • genericBodyStyle

    • isConsumer

    • modelMarketName

    • modelName

    • oemBodyStyle

    • sortOrder

    • trimId

    • vehicleClass

    • vehicleId

    • vehicleName

    • yearId

    • Changed property makeId (integer)

    • Changed property makeName (string)

    • Changed property modelId (integer)

    • Changed property modelName (string)

    • Changed property modelYearId (integer)

    • Changed property yearId (integer)

    • Changed property trimId (integer)

    • Changed property trimName (string)

    • Changed property vehicleClass (string)

    • Changed property modelPlusTrimName (string)

    • Changed property sortOrder (integer)

    • Changed property vehicleOptions (array)

      Changed items (object):

      New required properties:

      • hasRelationships

      • isConfigurable

      • isConsumer

      • isTypical

      • sortOrder

      • vehicleId

      • Added property vehicleOptionId (integer)

        Vehicle Option Id.

      • Added property vehicleId (integer)

        Vehicle Id.

      • Added property optionType (string)

        Option Type.

      • Added property optionName (string)

        Option Name.

      • Added property categoryName (string)

        Category Name.

      • Added property categoryGroup (string)

        Category Name.

      • Added property sortOrder (integer)

        Options Sort Order.

      • Added property isConsumer (boolean)

        Is Consumer.

      • Added property isTypical (boolean)

        Is Typical.

      • Added property isConfigurable (boolean)

        Is Configurable.

      • Added property hasRelationships (boolean)

        Has Relationships.

      • Deleted property items (array)

      • Deleted property isVinDecoded (boolean)

        Is VIN Decoded.

POST /mitek/verify-license

Return Type:

Changed response : 201 Created

Successful

• Changed content type : application/json

  • Changed property mitek_response (object)

    MiTek complete response.

    • Changed property evidence (array)

      Changed items (object):

      • Changed property extractedData (object)

        • Changed property name (object)

          New optional properties:

          • surname

      • Changed property images (array)

        Changed items (object):

        • Changed property classification (object)

          New optional properties:

          • imageType

        • Changed property extractedData (object)

          New optional properties:

          • dateOfBirth

          • dateOfExpiry

          • dateOfIssue

          • documentNumber

          • Changed property name (object)

            New optional properties:

            • dynamicProperties
            • fullName
            • givenNames
            • surname

          • Changed property address (object)

            New optional properties:

            • addressLine1
            • city
            • dynamicProperties
            • postalCode
            • stateProvince