API Docs Version 1.1.46

What's New

POST /void-contract

Void Contract

POST /email/send-payment-verification-email

Payment Verification Email

POST /email/send-payment-declined-email

Declined Payment Email

POST /email/send-payment-proof-acknowledgement-email

Payment Proof Acknowledgement Email

POST /email/payment-declined

Email Payment Declined

POST /email/send-subscription-termination-email

Send Access Termination Email

POST /email/send-pending-payment-proof-email

Send Pending Payment Proof Email

POST /email/bank-transfer-pending-approval-queue-email

Bank Transfer Pending Approval Queue Email

What's Deleted

POST /identity/auto-verify-license

Auto Verify License

POST /identity/manual-license-review

Manual License Review

GET /identity/poll

Retrieve Manual License Review Updates

GET /identity/retrieve-manual-results/{retrieval_id}

Retrieve Manual License Review Result

GET /mitek/mitek-account

Get Account Information

POST /mitek/mitek-account

Add Configuration Information

DELETE /mitek/mitek-account

Delete Account Information

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

POST /payment/account

Create Payment Account

GET /payment/account/{account_id}

Get Payment Account

POST /payment/account-link

Create Payment Account Link

POST /payment/payment-intent

Create Stripe Payment Intent

POST /payment/refund-for-payment-intent

Create Refund For Payment Intent

POST /payment/charge

Create Payment Charge

POST /payment/refund

Create Payment Refund

POST /plaid/link-token

Create link token

POST /plaid/access-token

Exchange public token for an access token

POST /plaid/stripe-bank-token

Create Stripe bank account token

POST /plaid/get-account-balance

Retrieve real-time balance data

What's Changed

GET /health

GET /version

POST /set-dealer

POST /get-dealer-products

POST /get-providers

POST /get-provider-products

POST /set-deal

POST /tradein/get-tradein-years

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-makes

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-models

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-modelyears

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-trims

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-allOptions

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-vehicle

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

POST /tradein/get-tradein-decodevin

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

GET /payment/stripe/configuration

POST /payment/stripe/configuration

DELETE /payment/stripe/configuration

PATCH /payment/stripe/configuration

GET /payment/plaid/configuration

POST /payment/plaid/configuration

DELETE /payment/plaid/configuration

PATCH /payment/plaid/configuration

POST /payment/setup-intents

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

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

DELETE /payment/payment-methods/{payment_method_id}

POST /payment/payment-intents

GET /payment/payment-intents/{payment_intent_id}

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

GET /payment/refunds

POST /payment/refunds

Request:

Changed content type : application/json

Changed property amount (number -> integer)

A positive integer in cents representing how much of this charge to refund. Can refund only up to the remaining.

GET /payment/refunds/{refund_id}

DELETE /payment/refunds/{refund_id}/cancel

POST /payment/link/token

POST /payment/bank-accounts

POST /payment/accounts

POST /payment/account-links

GET /payment/balance-transactions/{customer_id}

POST /payment/balance-transactions/{customer_id}

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

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

GET /payment/products

POST /payment/products

GET /payment/products/search

GET /payment/products/{product_id}

DELETE /payment/products/{product_id}

PATCH /payment/products/{product_id}

GET /payment/prices

POST /payment/prices

GET /payment/prices/{price_id}

PATCH /payment/prices/{price_id}

GET /payment/invoices/search

GET /payment/invoices/search-by-query

POST /payment/invoices/{invoice_id}/send

POST /payment/invoices/{invoice_id}/void

GET /payment/invoice/credit-notes

POST /payment/invoice-items

DELETE /payment/invoice-items

POST /payment/invoice-items/{invoice_item_id}

GET /events/{event_id}

GET /events

POST /set-dealer-fni-products

POST /tradein/get-tradein-vehiclevalue

Parameters:

Changed: x-service-provider in header

Vehicle valuation service to use

GET /payment/invoices

POST /payment/invoices

GET /payment/invoices/{invoice_id}

DELETE /payment/invoices/{invoice_id}

PATCH /payment/invoices/{invoice_id}

POST /payment/credit-notes/preview

GET /payment/credit-notes

POST /payment/credit-notes

GET /notification/otp-configuration

DELETE /notification/otp-configuration

POST /notification/otp-configuration

PATCH /notification/send-otp

POST /notification/verify-otp

POST /fraud-identification/email-auth-score

POST /account-verification/link/token

POST /account-verification/public-token/exchange

POST /account-verification/stripe/bank-account-token

POST /account-verification/accounts/balance/get

POST /credit/check

POST /customer/without-charge

Request:

Changed content type : application/json

Changed property card_details (object)

New required properties:
- token
New optional properties:
- cvc
- exp_month
- exp_year
- number
- Added property token (string)
- Added property is_default (boolean)
- Deleted property number (string)
- Deleted property exp_month (integer)
- Deleted property exp_year (integer)
- Deleted property cvc (string)

POST /customer/without-card

Request:

Changed content type : application/json

Changed property card_details (object)

New required properties:
- token
New optional properties:
- cvc
- exp_month
- exp_year
- number
- Added property token (string)
- Added property is_default (boolean)
- Deleted property number (string)
- Deleted property exp_month (integer)
- Deleted property exp_year (integer)
- Deleted property cvc (string)

POST /email/send-welcome-letter-email

Request:

Changed content type : application/json

New required properties:

product_names

Added property product_names (array)

Items (string):

POST /email/send-request-bank-transfer

Request:

Changed content type : application/json

New required properties:

tenant_name

Added property tenant_name (string)

POST /socure/email-auth-score

POST /customer/payment-method/attach/{stripe_customer_id}

Request:

Changed content type : application/json

New required properties:

token

New optional properties:

cvc
exp_month
exp_year
number

Added property token (string)
Added property is_default (boolean)
Deleted property number (string)
Deleted property exp_month (integer)
Deleted property exp_year (integer)
Deleted property cvc (string)

POST /get-rates

POST /get-preview-form

POST /get-filled-form

GET /configuration

DELETE /configuration

POST /configuration

Request:

Changed content type : application/json

Changed property vehicle_valuation (object)

Configuration for Vehicle Valuation
- Changed property vehicle_valuation_service (string)
  
  An enumeration.
  
  Added enum value:
  - JDPower
Changed property license_verification (object)

Configuration for License Verification
- Changed property mitek (object)
  
  Mitek account integration
  
  New required properties:
  - mitek_account

PATCH /configuration

Request:

Changed content type : application/json

Changed property vehicle_valuation (object)

Configuration for Vehicle Valuation
- Changed property vehicle_valuation_service (string)
  
  An enumeration.
  
  Added enum value:
  - JDPower
Changed property license_verification (object)

Configuration for License Verification
- Changed property mitek (object)
  
  Mitek account integration
  
  New required properties:
  - mitek_account

POST /customer/with-charge

Request:

Changed content type : application/json

Changed property customer_detail (object)
- Changed property card_details (object)
  
  New required properties:
  - token
  New optional properties:
  - cvc
  - exp_month
  - exp_year
  - number
  - Added property token (string)
  - Added property is_default (boolean)
  - Deleted property number (string)
  - Deleted property exp_month (integer)
  - Deleted property exp_year (integer)
  - Deleted property cvc (string)

POST /customer/payment-method

Request:

Changed content type : application/json

Changed property customer_detail (object)
- Changed property card_details (object)
  
  New required properties:
  - token
  New optional properties:
  - cvc
  - exp_month
  - exp_year
  - number
  - Added property token (string)
  - Added property is_default (boolean)
  - Deleted property number (string)
  - Deleted property exp_month (integer)
  - Deleted property exp_year (integer)
  - Deleted property cvc (string)

POST /mitek/verify-license

Version 1.1.50 Version 1.1.39