Preferred Lease Order Creation

This portal describes the process for creating orders for Preferred Lease utilizing our Merchant Portal Process.

The process flow is different based on a customer facing application such as a website and a non-customer facing application such as a merchant point of sale.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "https://merchant-portal-test.test-racapi.com/api/token" 
  -H "Authorization: devkey"

Make sure to replace meowmeowmeow with your API key.

• Token URLs is secured by basic authentication

• Production credentials will be provided by RAC team.

• Token returned by token API should be send as Authorization header for each API call.

• The token will expire after a certain amount of time not being used so you will need to code for an expired token.

Ecommerce

Approval Decision

curl --location --request POST 'https://merchant-portal-test.test-racapi.com/api/customer/getApprovalDecision/ecom' \
--header 'Content-Type: application/json' \
--header 'correlationid: asdf123' \
--data-raw '{
    "ADSRequest": {
        "MessageID": "12345",
        "MessageType": "CMS005",
        "MessageDTS": "2015-02-16-14:30:15:000633",
        "MessageDTSTZOffset": "-06:00",
        "Revision": "3.3",
        "RegionID": "1",
        "ClientID": "8",
        "ClientLocationNumber": "09327",
        "ClientSource": "1",
        "ClientOriginator": "1",
        "LocationNumber": "09327",
        "LocationFlow": "0",
        "ApprovalFlowType": "1",
        "EncryptionMethod": "0",
        "Body": {
            "ApprovalDecisionRequest": {
                "LanguagePreference": "1",
                "CustomerID": "564789",
                "CustomerAccountID ": "564789",
                "CreateCustomerFlag": "0",
                "PrefillFlag": "1",
                "AuthFlag": "1",
                "KBAResults": [
                    {
                        "KBAPassFlag": "1",
                        "KBAScore": "780",
                        "KBACaseID": "649c6036-0b26-4bad-8561-09f5fd03fb88|abab6cad-3b52-43cd-ba21-934e2c08df23"
                    }
                ],
                "VendorID": "BIG SANDY SUPERSTORE",
                "BankingInfo": {
                    "AccountType": "1",
                    "AccountNumber": "010987654323",
                    "RoutingNumber": "12345678",
                    "AccountValidated": "1"
                },
                "IDInfo": {
                    "IDType": "1",
                    "IssuingStateProvince": "GA",
                    "IDNumber": "308494386",
                    "NationalIDNumber": "111468673",
                    "DateOfBirth": "19751225",
                    "LastName": "Machesky",
                    "FirstName": "PatiCRTNK",
                    "MiddleName": "K",
                    "Address1": "1445 Allens Bridge",
                    "Address2": "Apt 201",
                    "City": "Greeneville",
                    "StateProvince": "TN",
                    "PostalCode": "37743",
                    "Country": "USA",
                    "Email": "ayghosa@yahoo.com",
                    "LengthOfResidence": "5",
                    "ResidenceType": "2",
                    "LandlordFirstName": "Landlord_FirstName ",
                    "LandlordLastName": "Landlord_LastName ",
                    "LandlordAddress1": "5500 Headquarters Drive",
                    "LandlordAddress2": "11",
                    "LandlordApartmentNumber": "234",
                    "LandlordPOBox": "1",
                    "LandlordCity": "Plano",
                    "LandlordStateProvince": "TX",
                    "LandlordPostalCode": "75024",
                    "LandlordPhoneNumber": "1234567891",
                    "PrimaryPhone": "5131235432",
                    "PrimaryPhoneType": "1",
                    "BestTimeToCall": "3",
                    "SecondaryPhone": "2704429041",
                    "SecondaryPhoneType": "2"
                },
                "IncomeInfo": {
                    "PrimarySourceOfIncome": "1",
                    "Employer": "Enterprise",
                    "JobTitle": " Job_Title ",
                    "EmployerAddress": "123 Main Street",
                    "EmployerPOBox": "7530",
                    "EmployerCity": "Plano",
                    "EmployerStateProvince": "TX",
                    "EmployerPostalCode": "75024",
                    "EmployerPhone": "9725551212",
                    "EmployerPhoneExtension": "1324",
                    "EmployerDoNotVisit": "1",
                    "EmployerDepartment": "HR",
                    "ShiftStartTime": "09:00",
                    "ShiftEndTime": "17:30",
                    "SupervisorFirstName": "Mike",
                    "SupervisorLastName": "Brown",
                    "LengthOfEmployment": "19",
                    "EmploymentStartDate": "20130610",
                    "MonthlyIncome": "4000",
                    "Schedule": "1",
                    "DaysPaid": "2"
                },
                "ReferenceInfo": [
                    {
                        "FirstName": "TENCHAR",
                        "LastName": "Matthews",
                        "Phone": "9725562323",
                        "Relationship": "1"
                    },
                    {
                        "FirstName": "Janet",
                        "LastName": "Matthews",
                        "Phone": "9725542100",
                        "Relationship": "1"
                    },
                    {
                        "FirstName": "Todd",
                        "LastName": "Smith",
                        "Phone": "5131335400",
                        "Relationship": "7"
                    }
                ]
            }
        }
    }
}'

The above command returns JSON structured like this:

{
  "ADSResponse": {
    "MessageID": "12345",
    "MessageType": "CMS105",
    "MessageDTS": "2015-12-23-12:17:58:000539",
    "MessageDTSTZOffset": "-06:00",
    "Revision": "3.3",
    "RegionID": "1",
    "ClientID": "8",
    "ClientLocationNumber": "09327",
    "ClientSource": "1",
    "ClientOriginator": "1",
    "LocationFlow": "0",
    "LocationNumber": "09327",
    "EncryptionMethod": "0",
    "StatusCode": "200",
    "StatusCodeDetail": "Success",
    "Body": {
"ApprovalDecisionResponse":    
{
         "MinimumApprovalAmount": "300",
        "ApprovalAmount": "3500",
        "OriginalApprovalAmount": "3500",
        "ApprovalExpirationDate": "2020-10-18",
        "CustomerID": "1213594",
        "ApprovalID": "1199744",
        "ApprovalResponse": "1"
}
    }
  }
}

Get Approval Decision for new customer (ADS)

ADS enables RAC partners to request a pre-approval option for Rent-To-Own or Lease Purchase opportunities, and add prospective customers into RAC’s back-end systems as leads to maximize business opportunities for both parties.

ADS is used to push consumer applicant application information for consideration for lease-to-purchase agreements. The service consumer may request that a real-time pre-approval be performed for the applicant. If so, an approval status, expiration date, amount (if applicable), and approval ID are included in the response.

Consumers of ADS may include Point of Sale (POS), eCommerce, Kiosks, and mobile devices.

• The customer information such as name, address, employment, etc should be collected and passed to the API

• The customer information will be validated and a decision will be returned: approved, declined or pending. A pending decision means more information is needed from the customer.

• A customer record will be created or updated if the customer already exists.

• A Customer ID and Location Number (store number) will be returned and needs to be sent in subsequent calls

HTTP Request

POST https://merchant-portal-test.test-racapi.com/api/customer/getApprovalDecision/ecom

Status Code Definition

This table defines the status code, cause, and suggested course of action when the code is received. See Appendix forexamples.

Request Header

_ Table 4‑1 Request Header _

Request Message

_ Table 4‑2 Request Message _

Response Header

* When receiving a StatusCode other than '200', some required fields may not be populated.

_ Table 4‑3 Response Header _

Response Message

* When receiving a StatusCode other than '200', some required fields may not be populated.

Request Header

Request Message

Response Header

* When receiving a StatusCode other than '200', some required fields may not be populated.

Response Message

* When receiving a StatusCode other than '200', some required fields may not be populated.

Field Values

Values are as follows for the fields that require specific valid values. The Client ID will be assigned and communicated outside of this document.

DaysPaid values when Schedule is weekly/ Bi-weekly

DaysPaid values when Schedule is Semi-Monthly

DaysPaid values when Schedule is Monthly

Find Existing Customer with an Approval (AMS205)

• A customer can be found based on certain criteria.

• One or more customers will be returned along with their approval information.

• A Customer ID and Location Number (store number) will be returned and needs to be sent in subsequent calls

Get Store Configurations (SMS205)

• Each store has a set of configurations such as agreement min/max, item min/max, categories (APP, FUR..) .

• UI will have to put rules based on min/max amounts for the Customer cart.

• Category on AGR/PMS services should be selected from categories returned by SMS service.

• https://merchant-portal-test.test-racapi.com/api/store/getStoreConfig/ecom

Send Text to Customer for Phone Validation

• As part of fraud prevention we want to validate the phone number is valid. A code is generated and texted to the phone number on file. The code must be entered to continue the process.

• https://merchant-portal-test.test-racapi.com/api/customer/verifyPhoneNumber

Get Price Quote (PMS204)

• The products selected by the customer should be passed in this request. The products will need to be mapped to our specific products.

• The customer should already have a valid approval.

• Rate, term, cash price and total cost will be returned.

• Optional products LDW and Benefits+ will also be returned.

• https://merchant-portal-test.test-racapi.com/api/quote/getPriceQuote/ecom

Create Agreement (AGR001)

• The customer must approve the terms along with accepting or declining the optional LDW and Benefits+.

• This API allows either online or remote signing. Online signing should be used for eCommerce applications and remote signing for non-customer facing applications.

• The response will be a redirect URL if online signing is selected.

• An email with a docusign link will be emailed to the customer if remote signing is selected.

• https://merchant-portal-test.test-racapi.com/api/agreement/createAgreement/ecom

Make Initial Payment

• After the customer has signed the documents, credit card information will need to be collected.

• Redirect the customer to the Add Pay URL for credit card entry.

• Initial payment returned by AGR service response should be sent on the Add Pay call.

• The card will be charged and an email will be sent to the customer confirming their order.

• A successful callback from Add Pay is the final step in the process.

• https://addpay.rentacenter.com/v1/customers/{customerId}/views/payment/recipient

Get List of Customers with Valid Approvals or Completed Signing

• A list of customers with valid approvals or a list of customers with signing documents completed but agreements not finalized will be returned.

• The list of customer with approvals will allow store coworkers to quickly find customers to begin their ordering process.

• The list of customer with Docusign complete will allow the store coworker to quickly find customers to finalize their agreement by entering their credit card information.

• This service is coming soon.

• https://merchant-portal-test.us-e1.cloudhub.io/api/customer/getCustomerList

Cancel agreement

• If the customer decides to not continue the process after create agreement, the cancel agreement process should be called.

• The cancel process will fail if the customer has already paid.

• This service is coming soon.

• https://merchant-portal-test.us-e1.cloudhub.io/api/agreement/cancel

Confirm delivery\update estimated delivery date

• When the delivery date to the customer has been set, call to update the estimated delivery date. If the delivery date changes, call to update our system with the new estimated delivery date.

• This service is coming soon.

• https://merchant-portal-test.us-e1.cloudhub.io/api/agreement/confirm

Errors

The Kittn API uses the following error codes: