Create Full Application

POST https://api.paytomorrow.com/api/ecommerce/application/create

Creates a PayTomorrow application and runs PayTomorrow's underwriting.

NOTE: When the purchase amount is out of your approval range, the application token will be null.

Description of Request Body:

{
    "orderId": "Order Id on your backend for future reference",
    "notifyUrl": "URL we will use to send postbacks to",
    // OPTIONAL
    "loanAmount": "Total amount we will be financing",
    // OPTIONAL
    "shipping": "Shipping costs",
    // OPTIONAL
    "taxes": "Taxes",
    // OPTIONAL
    "discount": "Discount if any",
    "personalInfo": {
        "ssn": "Full SSN",
        "dob": "Date of birth in ISO date format",
        "firstName": "First Name",
        "lastName": "Last Name",
        "cellPhone": "Cell phone",
        "email": "Email",
        // OPTIONAL
        "homePhone": "Home phone number",
        // OPTIONAL
        "idNumber": "Driver's license",
        // OPTIONAL
        "idState": "Driver's license two letter state code",
        // OPTIONAL
        "idIssueDate": "Date the driver's license was issued",
        // OPTIONAL
        "idExpirationDate": "Date the driver's license expires"
    },
    "employmentInfo": {
        // OPTIONAL
        "employerName": "Customer's Employer's name",
        // OPTIONAL
        "employerPhoneNumber": "Employer's phone number",
        // OPTIONAL
        "employerMonths": "Months at current Job",
        // OPTIONAL
        "employerYears": "Years at current Job",
        // OPTIONAL
        "selfEmployed": "Self employed true/false",
        // OPTIONAL
        "occupation": "Customer's occupation",
        // OPTIONAL
        "monthlyIncome": "Customer's monthly income (number only, no comas, periods or dollar signs)",
        // OPTIONAL
        "otherIncome": "Extra income if any",
        // OPTIONAL
        "otherIncomeDesc": "Other income description",
        "payCycle": "Pay cycle enum values can be (WEEKLY, BIWEEKLY, TWICE_PER_MONTH, MONTHLY)",
        "nextPayDate": "Next paycheck date in ISO date format",
        // Only required if payCycle is TWICE_PER_MONTH
        "previousPayDate": "Previous paycheck date in ISO date format"
    },
    "residenceInfo": {
        "streetName": "Street address",
        "city": "City",
        "state": "Two letter state code",
        "zip": "Zip Code",
        // OPTIONAL
        "rentOrOwn": "RentOrOwn enum values can be (Rent, Own, Other)",
        // OPTIONAL
        "residenceAmount": "Monthly cost of current residence",
        // OPTIONAL
        "residenceMonths": "Months at current residence",
        // OPTIONAL
        "residenceYears": "Years at current residence"
    },
    // OPTIONAL
    "items": [
        {
            "description": "Item description",
            "quantity": "Item quantity",
            "price": "Individual item price",
            "brand": "Item brand",
            "model": "Item model"
        }
    ]
}

Returns a json with

{
  "applicationToken": Store this token as it is a reference to the application,
  "orderId": Your Order ID,
  "loanAmount": the amount to be financed,
  "status": Application Status,
  "offers": [
        {
            "id": The offer Id,
            "overallTerm": Total Term,
            "leaseTerm": Lease Term,
            "loanTerm": Loan Term,
            "loanRate": The Loan Rate,
            "residualPercent": Lease Residual Percentage,
            "moneyFactor": Lease money factor,
            "offerType": "LEASELOAN",
            "leasePayment": Lease monthly payment amount,
            "loanPayment": Loan monthly payment amount,
            "residualPayment": Lease Residual value,
            "contractUrl": "The url to place in an iframe or redirect to. This generates the contract and will take the down payment."
        }
    ]
}

Request Params Requirements

  • "orderId": Required, any string is valid.
  • "firstName": Required, any string is valid.
  • "lastName": Required, any string is valid.
  • "street": Required, any string is valid.
  • "city": Required, any string is valid.
  • "zip": Required, 5 character length string.
  • "state": Required, 2 character length string.
  • "email": Required, must be a valid email.
  • "returnUrl": Must be a valid http or https url pattern.
  • "cancelUrl": Must be a valid http or https url pattern.
  • "notifyUrl": Must be a valid http or https url pattern.
  • "cellPhone": Must be a valid US phone number. Numbers only and no country code.
  • "loanAmount": Required, must be a number.
  • "shipping": must be a number.
  • "taxes": must be a number.
  • "applicationItems": Required.

Headers

Authorization: Bearer theacces-toke-naaa-aaaa-aaaaaaaaaaaa // The access token
Content-Type: application/json

Request Body

{
    "orderId": "order_id_on_your_system",
    "notifyUrl": "http://your-postback-url.com",
    "loanAmount": "1000",
    "shipping": "200",
    "taxes": "100",
    "discount": "0",
    "personalInfo": {
        "ssn": "123456789",
        "dob": "1970-12-30",
        "firstName": "David",
        "lastName": "Domingo",
        "homePhone": "9999999999",
        "cellPhone": "9999999999",
        "email": "david@email.com",
        "idNumber": "A12344555",
        "idState": "NC",
        "idIssueDate": "2016-12-30",
        "idExpirationDate": "2024-12-30"
    },
    "employmentInfo": {
        "employerName": "PayTomorrow",
        "employerPhoneNumber": "9999999999",
        "employerMonths": "10",
        "employerYears": "3",
        "selfEmployed": "false",
        "occupation": "Software Developer",
        "monthlyIncome": "9999",
        "otherIncome": "0",
        "otherIncomeDesc": "",
        "payCycle": "BIWEEKLY",
        "nextPayDate": "2020-04-30"
    },
    "residenceInfo": {
        "rentOrOwn": "Rent",
        "residenceAmount": "2000",
        "residenceMonths": "1",
        "residenceYears": "2",
        "streetName": "123 Main St",
        "city": "Raleigh",
        "state": "NC",
        "zip": "27777"
    },
    "items": [
        {
            "description": "Rose Gold iPhone Xs 256GB",
            "quantity": 1,
            "price": 1000,
            "brand": "Apple",
            "model": "iPhone Xs Rose Gold"
        }
    ]
}

Success Response Example

{
    "applicationToken": "92fc72f8-673a-4a29-9559-4c82d5f7378f",
    "orderId": "order_id_on_your_system",
    "loanAmount": 1000,
    "status": "A",
    "offers": [
        {
            "id": 14,
            "overallTerm": 6,
            "leaseTerm": 2,
            "loanTerm": 4,
            "loanRate": 18.8282,
            "residualPercent": 75,
            "moneyFactor": 0.03626,
            "offerType": "LEASELOAN",
            "leasePayment": 188.45,
            "loanPayment": 188.28,
            "residualPayment": 750,
            "contractUrl": "https://api.paytomorrow.com/ecommerce/application/92fc72f8-673a-4a29-9559-4c82d5f7378f/offers/select/14/redirect"
        },
        {
            "id": 15,
            "overallTerm": 12,
            "leaseTerm": 5,
            "loanTerm": 7,
            "loanRate": 9.25,
            "residualPercent": 74,
            "moneyFactor": 0.02529,
            "offerType": "LEASELOAN",
            "leasePayment": 96,
            "loanPayment": 92.5,
            "residualPayment": 740,
            "contractUrl": "https://api.paytomorrow.com/ecommerce/application/92fc72f8-673a-4a29-9559-4c82d5f7378f/offers/select/15/redirect"
        },
        {
            "id": 16,
            "overallTerm": 18,
            "leaseTerm": 9,
            "loanTerm": 9,
            "loanRate": 7.7778,
            "residualPercent": 70,
            "moneyFactor": 0.02628,
            "offerType": "LEASELOAN",
            "leasePayment": 78.01,
            "loanPayment": 77.77,
            "residualPayment": 700,
            "contractUrl": "https://api.paytomorrow.com/ecommerce/application/92fc72f8-673a-4a29-9559-4c82d5f7378f/offers/select/16/redirect"
        },
        {
            "id": 17,
            "overallTerm": 24,
            "leaseTerm": 12,
            "loanTerm": 12,
            "loanRate": 5.5,
            "residualPercent": 66,
            "moneyFactor": 0.01787,
            "offerType": "LEASELOAN",
            "leasePayment": 58,
            "loanPayment": 55,
            "residualPayment": 660,
            "contractUrl": "https://api.paytomorrow.com/ecommerce/application/92fc72f8-673a-4a29-9559-4c82d5f7378f/offers/select/17/redirect"
        }
    ]
}
← Create OrderSettle Application →