Flows

Flows are UI experiences provided by the SDK that can be launched from your website.

Available Flows

The available flows are the following

• application - A financing application where the user can apply for financing with one or more providers.
• checkout - Provides the user experience need to authorize a financed purchase
• lookup - Provides the user experience to locate a financing account

Launching Flows

var vcredit = VCredit.create({
    secureSessionUrl: 'https://yourbackend.com/sessions',
    target: '_blank'
})
vcredit.on('ready', function () {
    vcredit.launch('application')
})

Application Flow

This flow launches a credit application in an iFrame.

Options

Applicant Object Fields

Address Object Fields

Events

application.start

Fired when the application has started.

application.end

Fired when the application is completed. The data that is returned contains the following fields:

application.{status}

A version of the application.end event that's fired for a specific status. For example, application.approved is fired when the application has been approved. This allows the client to avoid conditional status logic.

prequalification.start

Fired when the pre-qualification view is displayed. This event is fired for every pre-qualification in the cascade.

prequalification.end

Fired when the pre-qualification is done. This event is fired for every pre-qualification in the cascade. The data that is returned contains the following fields:

prequalification.{status}

A version of the prequalification.end event that's fired for a specific status. For example, prequalification.prequalified is fired when the user has been pre-qualified. This allows the client to avoid conditional status logic.

Example

var vcredit = VCredit.create({
    secureSessionUrl: 'https://yourbackend.com/sessions'
})
vcredit.on('application.end', function(event) {
    post('https://yourbackend.com/application/result', event.data)
    event.element.destroy()
});
vcredit.on('application.approved', function(event) {
    event.element.destroy()
});
vcredit.launch('application', {
    prefill: {
        expectedPurchaseAmount: 100000, // $1000
        primaryApplicant: {
            firstName: "John",
            middleInitial: 'C',
            lastName: "Smith",
            address: {
                addressLine1: '4900 Ritter Rd',
                addressLine2: 'Apt 4',
                city: 'Mechanicsburg',
                state: 'PA',
                postalCode: '17055'
            },
            email: 'johnsmith@fakemail.net',
            dateOfBirth: '1991-01-01',
            homePhone: '5556667777',
            mobilePhone: '5556667777',
            workPhone: '5556667777'
        },
        jointApplicant: {
            // ...
        }
    }
})

Checkout Flow

This flow launches a checkout UI used to prepare a payment.

Options

Events

checkout.start

Fire when the checkout flow has started.

checkout.end

Fired when the checkout flow is completed. The data that is returned contains the following fields:

checkout.{status}

A version of the checkout.end event that's fired for a specific status. For example, checkout.success is fired when the user has successfully completed the checkout process.

Example

var vcredit = VCredit.create({
    secureSessionUrl: 'https://yourbackend.com/sessions'
})
vcredit.on('checkout.end', function(event) {
   var result = event.data
   console.log('Status:', result.status, 'Checkout Id:', result.checkoutId)
});
vcredit.launch('checkout', {
    amount: 80000,
    applicationId: "asdf9kj234243432",
    invoiceNumber: "1234",
    items: [
        {
            "productCode": "9213i499843",
            "description": "couch"
            "price": 80000,
            "quantity": 1
        }
    ],
    shippingAddress: {
        "addressLine1": "300 Welcome Way",
        "city": "Mechanicsburg"
        "state": "PA"
        "postalCode": "17050"
    }
})

Lookup Flow

This flow performs an account lookup.

Options

There are no options at this time.

Events

account.lookup

Fired when a search has been performed. The data that is returned contains the following fields.

account.{status}

Variation of account.lookup that fires on the specified status. For example, account.found is fired only when an account has been found.

Example

var vcredit = VCredit.create({
    secureSessionUrl: 'https://yourbackend.com/sessions'
})
vcredit.on('account.lookup', function(event) {
   var result = event.data
   console.log('Status:', result.status, 'Account Id:', result.accountId)
});
vcredit.launch('lookup', {})