Create lease application

post

https://capi.beta.progleasing.com/api/v1/application

Receives all information required to decision a lease application. Can return an Approved, Denied or Conditional approval.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

store

object

An object that contains the details of the Merchant and their Store.

disclosureCode

int64

This code represents the electronic disclosure code sent to a customer's mobile device. If not using electronic disclosures, this data element can be null.

languagePreference

string

enum

This is used to generate the lease agreement and other communications from Progressive in the language preference provided. Valid entires include en (english) and es (spanish).

Allowed:

marketingOptIn

boolean

This is a Boolean value indicating if the customer has consented to receive Marketing communications from Progressive Leasing.

smsOptIn

boolean

If a store is set up to send a SMS message when a cart is submitted, and the value from this field is false, a customer will not receive a SMS message to sign their lease agreement. This will override the store setting.

threatMetrixId

string | null

The unique ThreatMetrix Identification for the given customer. If you aren't using ThreatMetrix, leave empty.

applicationSource

string | null

Identifies the primary integration source of the application. This value is provided by Progressive Leasing.

customer

object

An object that contains the details of the Customer.

bank

object

Bank Information

custom

object

This object contains custom application fields as required by different flows. Your Implementation Manager will let you know if there is anything required in this section.

leaseSource

object

Lease source integration details.

applicationId

int32

The Id of the application to patch or update.

Responses

201Created

400Invalid input

401Unauthorized

403Forbidden

500Internal Service Error