Create lease application

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

Request body

disclosureCodeinteger

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'En' | 'Es'

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).

marketingOptInboolean

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

smsOptInboolean

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.

threatMetrixIdstring nullable

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

applicationSourcestring nullable

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

applicationIdinteger

The Id of the application to patch or update.

Example request

{
  "store": {
    "progressiveMerchantId": 111111,
    "merchantStoreId": "UT",
    "salesAssociate": "John Smith"
  },
  "disclosureCode": 12345,
  "marketingOptIn": true,
  "smsOptIn": true,
  "customer": {
    "merchantCustomerId": "1234",
    "firstName": "John",
    "lastName": "Doe",
    "ssn": "111111111",
    "birthdate": "01-01-1980",
    "homePhone": "8015111111",
    "cellPhone": "8015111111",
    "emailAddress": "test.user@example.com",
    "incomeSourceType": "Salary",
    "incomeName": "MyCompany",
    "grossIncomeMonthly": 3000,
    "paymentFrequency": {
      "nextPayDate": "01-01-2000",
      "lastPayDate": "01-01-2000"
    },
    "creditCard": {
      "cardNumber": "1111111111111111",
      "cardBin": "111111",
      "cvv": "111",
      "expirationDate": "01-01-2024",
      "expirationMonth": 1,
      "expirationYear": 28,
      "firstNameOnCard": "John",
      "lastNameOnCard": "Doe",
      "billingAddress": {
        "streetAddress1": "123 Fake Street",
        "streetAddress2": "456 Artificial Drive",
        "city": "Draper",
        "state": "UT",
        "zip": "84020"
      }
    },
    "identification": {
      "state": "UT",
      "number": "123456789"
    },
    "homeAddress": {
      "streetAddress1": "123 Fake Street",
      "streetAddress2": "456 Artificial Drive",
      "city": "Draper",
      "state": "UT",
      "zip": "84020"
    }
  },
  "leaseSource": {
    "company": "merchant",
    "brand": "merchant_site_2",
    "flow": "checkout_page",
    "integrator": "website_plugin"
  },
  "applicationId": 8165148
}

Response

Created

applicationIdstring nullable

This is the Account Number (AKA Lease ID) as assigned by Progressive Leasing.

statusstring nullable

Defines the current status of an Application. Valid statuses include: Approved, Denied, Pending, and Pre-Approved.

approvalAmountnumber double

The dollar amount a customer has been approved for.

isOkToDeliverboolean

Indicates whether an Application is ready for delivery.

merchantCustomerIdstring nullable

MerchantCustomerId provided by client.

v1

Create lease application

Request body

Example request

Response