API Docs Version 1.1.36

What's New

POST /set-deal

Set Deal

GET /payment/refunds/{refund_id}

Get a refund

DELETE /payment/refunds/{refund_id}/cancel

Cancel a refund

POST /payment/accounts

Create account

POST /payment/account-links

Create account link

GET /payment/balance-transactions/{customer_id}

List all customer balance transactions

POST /payment/balance-transactions/{customer_id}

Create a customer balance transaction

GET /payment/balance-transactions/{customer_id}/{balance_transaction_id}

Get a customer balance transaction

PATCH /payment/balance-transactions/{customer_id}/{balance_transaction_id}

Update a customer balance transaction

GET /payment/products

List all products

POST /payment/products

Create a product

GET /payment/products/search

Search Products

GET /payment/products/{product_id}

Get a product

DELETE /payment/products/{product_id}

Delete a product

PATCH /payment/products/{product_id}

Update a product

GET /payment/prices

Get price list

POST /payment/prices

Create a price

GET /payment/prices/{price_id}

Get a price

PATCH /payment/prices/{price_id}

Update a price

GET /payment/invoices

List all invoices

POST /payment/invoices

Create Invoice

GET /payment/invoices/search

Search Invoices

GET /payment/invoices/search-by-query

Search Invoices

GET /payment/invoices/{invoice_id}

Get Invoice

DELETE /payment/invoices/{invoice_id}

Delete Invoice

PATCH /payment/invoices/{invoice_id}

Update Invoice

POST /payment/invoices/{invoice_id}/send

Send Invoice

POST /payment/invoices/{invoice_id}/void

Void an Invoice

POST /payment/credit-notes/preview

Preview a credit note

GET /payment/credit-notes

List credit notes

POST /payment/credit-notes

Create a credit note

GET /payment/invoice/credit-notes

Get invoice credit notes

POST /payment/invoice-items

Create Invoice Items

DELETE /payment/invoice-items

Delete Invoice Items

POST /payment/invoice-items/{invoice_item_id}

Update Invoice Items

GET /payment/webhook-endpoints

List Webhook endpoints

POST /payment/webhook-endpoints

Create Webhook endpoint

GET /payment/webhook-endpoints/{webhook_endpoint_id}

Get a Webhook endpoint

DELETE /payment/webhook-endpoints/{webhook_endpoint_id}

Delete a Webhook endpoint

PATCH /payment/webhook-endpoints/{webhook_endpoint_id}

Update Webhook endpoint

GET /payment/refunds

List all refunds

What's Changed

POST /set-dealer

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /get-providers

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /get-provider-products

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /get-dealer-products

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-years

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-makes

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all makes will be returned

  • Added property start_year (integer)

  • Added property end_year (integer)

  • Added property category_id (integer)

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-models

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Request:

Changed content type : application/json

• Changed property filter (object)

  If not specified, all models will be returned

  • Added property start_year (integer)

  • Added property end_year (integer)

  • Added property category_id (integer)

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-modelyears

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-trims

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-allOptions

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-vehicle

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /tradein/get-tradein-decodevin

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /payment/stripe/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 500 Internal Server Error

Internal Server Error

POST /payment/stripe/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

DELETE /payment/stripe/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 500 Internal Server Error

Internal Server Error

PATCH /payment/stripe/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /payment/plaid/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 500 Internal Server Error

Internal Server Error

POST /payment/plaid/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

DELETE /payment/plaid/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 500 Internal Server Error

Internal Server Error

PATCH /payment/plaid/configuration

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /payment/setup-intents

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

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

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

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

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

DELETE /payment/payment-methods/{payment_method_id}

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /payment/payment-intents

Parameters:

Changed: x-service-provider in header

Payment service to use

Request:

Changed content type : application/json

• Added property receiver_account (string)

  ID of the connected account to which you want to debit the amount.

• Added property user_details (object)

  User details.

  • Property first_name (string)

  • Property last_name (string)

  • Property address (string)

  • Property phone (string)

  • Property zip (string)

  • Property city (string)

  • Property country (string)

  • Property state (string)

  • Property email (string)

  • Property identification (string)

• Changed property currency (string)

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• Changed property billing_address (object)

  The billing address of the user.

  • Changed property country (string)

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property payment_option (object)

    Detailed representation of the payment method.

    • Property redirect_url (string)

    • Property payment_method (string)

    • Property card (object)

  • Added property order_id (string)

    The merchant order Id.

  • Deleted property service_provider (string)

    Service provider of this PaymentIntent.

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /payment/payment-intents/{payment_intent_id}

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

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

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /payment/refunds

Parameters:

Added: x-api-version in header

Request:

Changed content type : application/json

• Added property connect_account (string)

  ID of the connect account.

• Changed property payment_intent (string)

  ID of the PaymentIntent to refund. Pass either payment_intent or charge.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /payment/link/token

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /payment/bank-accounts

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /events/{event_id}

Parameters:

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /events

Parameters:

Added: related_object in query

A string containing a specific related object name. The list will be filtered to include only events with a matching event property.

Added: x-api-version in header

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /set-dealer-fni-products

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /mitek/mitek-account

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property webhook_url (string)

POST /tradein/get-tradein-vehiclevalue

Parameters:

Added: x-api-version in header

Changed: x-service-provider in header

Vehicle valuation service to use

Request:

Changed content type : application/json

• Added property start_year (integer)

• Added property end_year (integer)

• Added property model_id (integer)

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 401 Unauthorized

UnAuthorized Request

Changed response : 201 Created

Successful Response

Changed response : 400 Bad Request

Bad Request

• New content type : application/json

Changed response : 404 Not Found

Not Found

• New content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /fraud-identification/email-auth-score

Parameters:

Changed: x-service-provider in header

Fraud service to use

Request:

Changed content type : application/json

• Added property device_session_id (string)

  The session ID retrieved from the consumer's browser.

POST /configuration

Request:

Changed content type : application/json

• Changed property payment (object)

  Configuration for the Payment

  • Changed property stripe (object)

    Stripe Payment Configuration

    • Added property web_hooks (array)

      Stripe webhooks configuration

      Items (object):

      • Property url (string)

        The URL of the webhook endpoint.

      • Property enabled_events (array)

        The list of events to enable for this endpoint

        Items (string):

        An enumeration.

        Enum values:

        • account.updated
        • payment_intent.created
        • payment_intent.canceled
        • payment_intent.processing
        • payment_intent.requires_action
        • payment_intent.succeeded
        • payment_intent.payment_failed
        • charge.expired
        • charge.failed
        • charge.pending
        • charge.refund.updated
        • charge.refunded
        • charge.succeeded
        • charge.updated
        • customer_cash_balance_transaction.created
        • customer.created
        • customer.updated
        • customer.deleted
        • invoice.created
        • invoice.deleted
        • invoice.finalization_failed
        • invoice.finalized
        • invoice.marked_uncollectible
        • invoice.paid
        • invoice.payment_action_required
        • invoice.payment_failed
        • invoice.payment_succeeded
        • invoice.sent
        • invoice.upcoming
        • invoice.updated
        • invoice.voided
        • setup_intent.canceled
        • setup_intent.created
        • setup_intent.requires_action
        • setup_intent.setup_failed
        • setup_intent.succeeded

• Changed property license_verification (object)

  Configuration for License Verification

  • Changed property mitek (object)

    Mitek account integration

    • Added property webhook_url (string)

      Webhook url for manual review response

PATCH /configuration

Request:

Changed content type : application/json

• Changed property payment (object)

  Configuration for the Payment

  • Changed property stripe (object)

    Stripe Payment Configuration

    • Added property web_hooks (array)

      Stripe webhooks configuration

• Changed property license_verification (object)

  Configuration for License Verification

  • Changed property mitek (object)

    Mitek account integration

    • Added property webhook_url (string)

      Webhook url for manual review response

POST /credit/check

Parameters:

Changed: x-service-provider in header

Credit service to use

POST /email/send-welcome-letter-email

Request:

Changed content type : application/json

• Changed property details (array -> object)

POST /email/send-payment-invoice-email

Request:

Changed content type : application/json

• Changed property extra_charges (array)

  Changed items (object):

  New required properties:

  • product_name

  • Added property product_name (string)

POST /get-rates

Request:

Changed content type : application/json

• Changed property deal_info (object)

  Information specific to the entire Deal. See DSIDealInfo.

  • Changed property customer_info (object)

    Customer Information. See DSICustomerInfo.

    • Changed property gender (string)

      An enumeration.

      Added enum value:

      • <class 'libintegration.domain.enums.Gender.Config'>

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property rates (object)

    • Changed property rate (object)

      • Changed property coverages (object)

        • Changed property coverage (array -> object)

      • Changed property product_id (string -> integer)

        PEN Product Id.

      • Changed property includes_prices (string -> boolean)

        Includes prices?.

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /get-preview-form

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /get-filled-form

Return Type:

New response : 400 Bad Request

Bad Request

New response : 404 Not Found

Not Found

New response : 500 Internal Server Error

Internal Server Error

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /mitek/verify-license

Parameters:

Changed: x-service-provider in header

License verification service to use

Return Type:

Changed response : 201 Created

Successful

• Changed content type : application/json

  • Added property error (object)

    License validation error

    • Property error_code (string)

      Error code

    • Property error_message (string)

      Error message.

  • Added property identifier (string)

  • Added property created_at (string)

  • Changed property mitek_response (object)

    MiTek complete response.

    • Changed property findings (object)

      • Changed property verifications (array)

        Changed items (object):

        • Changed property notifications (object)

          • Deleted property 212 (string)

          • Deleted property 670 (string)

          • Deleted property 699 (string)

    • Changed property evidence (array)

      Changed items (object):

      • Changed property images (array)

        Changed items (object):

        • Changed property processingReasons (object)

          • Deleted property 502 (string)