API Docs Version 1.1.69

What's New

DELETE /payment/customers/{customer_id}

Delete a customer

What's Changed

POST /set-dealer

Request:

Changed content type : application/json

• Changed property penDealerId (integer)

  PEN Dealer ID Number. Set to zero (0) for Action REGISTER or set dealer id value for Action UPDATE and UNREGISTER

POST /payment/setup-intents

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property client_secret (string)

    The client secret of this Payment Intent/SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer.

  • Changed property payment_method (string)

    ID of the payment method (a Payment Method, Card, or saved Source object) to attach to this SetupIntent.

GET /payment/payment-methods/all/{customer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property billing_details (object)

    Billing information associated with the Payment Method that may be used or required by particular types of payment methods.

    • Changed property address (object)

      Billing address.

      • Changed property country (string)

        2-letter country code if created through the Payment Methods API.

  • Changed property customer (string)

    The ID of the Customer to which this Payment Method is saved. This will not be set when the Payment Method has not been saved to a Customer.

  • Changed property type (string)

    The type of the Payment Method. An additional hash is included on the Payment Method with a name matching this value. It contains additional information specific to the Payment Method type.

  • Changed property card (object)

    If this is a card Payment Method, this hash contains the user’s card details.

  • Changed property us_bank_account (object)

    If this is an us_bank_account Payment Method, this hash contains details about the US bank account payment method.

PATCH /payment/payment-methods/{customer_id}/{payment_method_id}

DELETE /payment/payment-methods/{payment_method_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property billing_details (object)

    Billing information associated with the Payment Method that may be used or required by particular types of payment methods.

    • Changed property address (object)

      Billing address.

      • Changed property country (string)

        2-letter country code if created through the Payment Methods API.

  • Changed property customer (string)

    The ID of the Customer to which this Payment Method is saved. This will not be set when the Payment Method has not been saved to a Customer.

  • Changed property type (string)

    The type of the Payment Method. An additional hash is included on the Payment Method with a name matching this value. It contains additional information specific to the Payment Method type.

  • Changed property card (object)

    If this is a card Payment Method, this hash contains the user’s card details.

  • Changed property us_bank_account (object)

    If this is an us_bank_account Payment Method, this hash contains details about the US bank account payment method.

GET /payment/payment-intents/{payment_intent_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property amount (integer)

    Amount intended to be collected by this Payment Intent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

  • Changed property charges (object)

    Charges that were created by this Payment Intent, if any.

  • Changed property client_secret (string)

    The client secret of this Payment Intent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer.

  • Changed property customer (string)

    ID of the Customer this Payment Intent belongs to, if one exists.

  • Changed property last_payment_error (object)

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

  • Changed property payment_method (string)

    ID of the payment method used in this Payment Intent.

  • Changed property payment_method_types (array)

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

  • Changed property setup_future_usage (string)

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

  • Changed property shipping (object)

    Shipping information for this Payment Intent.

  • Changed property status (string)

    Status of this Payment Intent.

  • Changed property amount_capturable (integer)

    Amount that can be captured from this Payment Intent.

  • Changed property amount_received (integer)

    Amount that was collected by this Payment Intent.

  • Changed property application (string)

    ID of the Connect application that created the Payment Intent.

  • Changed property canceled_at (integer)

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

  • Changed property cancellation_reason (string)

    Reason for cancellation of this Payment Intent.

  • Changed property invoice (string)

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

  • Changed property on_behalf_of (string)

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

  • Changed property payment_method_options (object)

    Payment-method-specific configuration for this Payment Intent.

    • Changed property card (object)

      If the Payment Intent’s payment_method_types includes card, this hash contains the configurations that will be applied to each payment attempt of that type.

  • Changed property review (string)

    ID of the review associated with this Payment Intent, if any.

DELETE /payment/payment-intents/{payment_intent_id}/cancel

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property amount (integer)

    Amount intended to be collected by this Payment Intent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

  • Changed property charges (object)

    Charges that were created by this Payment Intent, if any.

  • Changed property client_secret (string)

    The client secret of this Payment Intent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer.

  • Changed property customer (string)

    ID of the Customer this Payment Intent belongs to, if one exists.

  • Changed property last_payment_error (object)

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

  • Changed property payment_method (string)

    ID of the payment method used in this Payment Intent.

  • Changed property payment_method_types (array)

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

  • Changed property setup_future_usage (string)

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

  • Changed property shipping (object)

    Shipping information for this Payment Intent.

  • Changed property status (string)

    Status of this Payment Intent.

  • Changed property amount_capturable (integer)

    Amount that can be captured from this Payment Intent.

  • Changed property amount_received (integer)

    Amount that was collected by this Payment Intent.

  • Changed property application (string)

    ID of the Connect application that created the Payment Intent.

  • Changed property canceled_at (integer)

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

  • Changed property cancellation_reason (string)

    Reason for cancellation of this Payment Intent.

  • Changed property invoice (string)

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

  • Changed property on_behalf_of (string)

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

  • Changed property payment_method_options (object)

    Payment-method-specific configuration for this Payment Intent.

    • Changed property card (object)

      If the Payment Intent’s payment_method_types includes card, this hash contains the configurations that will be applied to each payment attempt of that type.

  • Changed property review (string)

    ID of the review associated with this Payment Intent, if any.

GET /payment/refunds

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/refunds

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property payment_intent (string)

    ID of the Payment Intent that was refunded.

GET /payment/refunds/{refund_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property payment_intent (string)

    ID of the Payment Intent that was refunded.

DELETE /payment/refunds/{refund_id}/cancel

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property payment_intent (string)

    ID of the Payment Intent that was refunded.

POST /payment/link/token

POST /payment/bank-accounts

Request:

Changed content type : application/json

• Changed property public_token (string)

  Public token received from the Link OnSuccess callback

• Changed property account_id (string)

  Account id received from the Link OnSuccess callback

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property billing_details (object)

    Billing information associated with the Payment Method that may be used or required by particular types of payment methods.

    • Changed property address (object)

      Billing address.

      • Changed property country (string)

        2-letter country code if created through the Payment Methods API.

  • Changed property customer (string)

    The ID of the Customer to which this Payment Method is saved. This will not be set when the Payment Method has not been saved to a Customer.

  • Changed property type (string)

    The type of the Payment Method. An additional hash is included on the Payment Method with a name matching this value. It contains additional information specific to the Payment Method type.

  • Changed property card (object)

    If this is a card Payment Method, this hash contains the user’s card details.

  • Changed property us_bank_account (object)

    If this is an us_bank_account Payment Method, this hash contains details about the US bank account payment method.

POST /payment/accounts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/accounts/{account_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/products

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/products

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/products/search

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/products/{product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

DELETE /payment/products/{product_id}

PATCH /payment/products/{product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/prices

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/prices

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/prices/{price_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

PATCH /payment/prices/{price_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/invoices/search

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/invoices/search-by-query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/invoices/{invoice_id}/send

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/invoices/{invoice_id}/void

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /events/{event_id}

Get an Event

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /events

Get List of All Events

Parameters:

Changed: delivery_success in query

Filter events by whether all webhooks were successfully delivered. If False, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.

Changed: type in query

A string containing a specific event name like payment_intent.created, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.

Return Type:

Changed response : 200 OK

Successful Response

• 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

  • Changed property category_id (integer)

    Category ID for filtering vehicle valuations

POST /tradein/get-tradein-models

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all models will be returned

  • Changed property category_id (integer)

    Category ID for filtering vehicle valuations

POST /tradein/get-tradein-allOptions

GET /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

DELETE /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

PATCH /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/invoices/upcoming

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /credit/check

Request:

Changed content type : application/json

• Changed property first_name (string)

  First name

• Changed property middle_name (string)

  Middle name

• Changed property last_name (string)

  Last name

• Changed property suffix (string)

  Suffix e.g., Jr., Sr., III

• Changed property date_of_birth (string)

  Date of birth in YYYY-MM-DD format, e.g., 2023-03-20

• Changed property gender (string)

  Gender e.g., Male, Female, Other

• Changed property phone_numbers (array)

  List of phone numbers associated with the individual

• Changed property occupation (string)

  Occupation or profession

• Changed property employer (string)

  Name of the individual's employer

• Changed property driver_license_number (string)

  Driver's license number

• Changed property social_security_number (string)

  Social Security Number

• Changed property addresses (array)

  List of addresses associated with the individual

POST /dms/leads

Parameters:

Changed: x-service-provider in header

lead to use

GET /dms/leads/{customer_id}

Parameters:

Changed: x-service-provider in header

lead to use

PATCH /dms/leads/{customer_id}

Parameters:

Changed: x-service-provider in header

lead to use

GET /api/verify-address/{address}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property error_message (string)

GET /configuration

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property inventory_server (object)

    Configuration for inventory server

  • Changed property fraud_identification (object)

    Configuration for Fraud Identification

    • Deleted property fraud_ttl (integer)

      Fraud Identification TTL

  • Changed property credit_application (object)

    Configuration for Credit Application

    • Deleted property credit_ttl (integer)

      Credit Application TTL

    • Changed property transunion (object)

      TransUnion Configuration

      • Changed 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.

        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 dealer_management_system (object)

    Configuration for dms

    • Changed property dealer_track (object)

      Dealer Track Configuration

      • Deleted property multilender (object)

        Configuration settings for integrating with DealerTrack's multi-lender platform.

      • Changed property dms (object)

        Configuration settings for DealerTrack's DMS.

        • Changed property api_url (string)

          API URL for DealerTrack

        • Changed property username (string)

          Username for DealerTrack

        • Changed property password (string)

          Password for DealerTrack

        • Changed property enterprise_code (string)

          Enterprise code for DealerTrack

        • Changed property company_number (string)

          Company number for DealerTrack

POST /configuration

Request:

Changed content type : application/json

• Deleted property inventory_server (object)

• Changed property fraud_identification (object)

  • Deleted property fraud_ttl (integer)

    Fraud Identification TTL

• Changed property credit_application (object)

  • Deleted property credit_ttl (integer)

    Credit Application TTL

  • Changed property transunion (object)

    TransUnion Configuration

    • Changed 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.

      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 dealer_management_system (object)

  • Changed property dealer_track (object)

    Dealer Track Configuration

    • Deleted property multilender (object)

      Configuration settings for integrating with DealerTrack's multi-lender platform.

    • Changed property dms (object)

      Configuration settings for DealerTrack's DMS.

      • Changed property api_url (string)

        API URL for DealerTrack

      • Changed property username (string)

        Username for DealerTrack

      • Changed property password (string)

        Password for DealerTrack

      • Changed property enterprise_code (string)

        Enterprise code for DealerTrack

      • Changed property company_number (string)

        Company number for DealerTrack

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property inventory_server (object)

    Configuration for inventory server

  • Changed property fraud_identification (object)

    Configuration for Fraud Identification

    • Deleted property fraud_ttl (integer)

      Fraud Identification TTL

  • Changed property credit_application (object)

    Configuration for Credit Application

    • Deleted property credit_ttl (integer)

      Credit Application TTL

    • Changed property transunion (object)

      TransUnion Configuration

      • Changed 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.

        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 dealer_management_system (object)

    Configuration for dms

    • Changed property dealer_track (object)

      Dealer Track Configuration

      • Deleted property multilender (object)

        Configuration settings for integrating with DealerTrack's multi-lender platform.

      • Changed property dms (object)

        Configuration settings for DealerTrack's DMS.

        • Changed property api_url (string)

          API URL for DealerTrack

        • Changed property username (string)

          Username for DealerTrack

        • Changed property password (string)

          Password for DealerTrack

        • Changed property enterprise_code (string)

          Enterprise code for DealerTrack

        • Changed property company_number (string)

          Company number for DealerTrack

PATCH /configuration

Request:

Changed content type : application/json

• Deleted property inventory_server (object)

• Changed property fraud_identification (object)

  • Deleted property fraud_ttl (integer)

    Fraud Identification TTL

• Changed property credit_application (object)

  • Deleted property credit_ttl (integer)

    Credit Application TTL

  • Changed property transunion (object)

    TransUnion Configuration

    • Changed 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.

      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 dealer_management_system (object)

  • Changed property dealer_track (object)

    Dealer Track Configuration

    • Deleted property multilender (object)

      Configuration settings for integrating with DealerTrack's multi-lender platform.

    • Changed property dms (object)

      Configuration settings for DealerTrack's DMS.

      • Changed property api_url (string)

        API URL for DealerTrack

      • Changed property username (string)

        Username for DealerTrack

      • Changed property password (string)

        Password for DealerTrack

      • Changed property enterprise_code (string)

        Enterprise code for DealerTrack

      • Changed property company_number (string)

        Company number for DealerTrack

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property inventory_server (object)

    Configuration for inventory server

  • Changed property fraud_identification (object)

    Configuration for Fraud Identification

    • Deleted property fraud_ttl (integer)

      Fraud Identification TTL

  • Changed property credit_application (object)

    Configuration for Credit Application

    • Deleted property credit_ttl (integer)

      Credit Application TTL

    • Changed property transunion (object)

      TransUnion Configuration

      • Changed 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.

        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 dealer_management_system (object)

    Configuration for dms

    • Changed property dealer_track (object)

      Dealer Track Configuration

      • Deleted property multilender (object)

        Configuration settings for integrating with DealerTrack's multi-lender platform.

      • Changed property dms (object)

        Configuration settings for DealerTrack's DMS.

        • Changed property api_url (string)

          API URL for DealerTrack

        • Changed property username (string)

          Username for DealerTrack

        • Changed property password (string)

          Password for DealerTrack

        • Changed property enterprise_code (string)

          Enterprise code for DealerTrack

        • Changed property company_number (string)

          Company number for DealerTrack

POST /dms/deals

Request:

Changed content type : application/json

• Changed property finance (object)

  New optional properties:

  • tires_cost

GET /dms/leads/search

Parameters:

Changed: x-service-provider in header

lead to use