Simulate Loan

post

https://lending-{corename}.{env}.gpsrv.com/lending/1.0/simulateLoan

Use the Simulate Loan endpoint to present loan terms to individual and business customers. Simulate Loan allows customers to run multiple loan simulations, to compare the different APRs and loan terms, and make an informed decision about the loan offerings. The 36% MAPR is only applicable to individual customer loans, and there is no limit for business customer loans. This endpoint generates the data needed to create loan documents such as the Truth in Lending Act (TILA) document and loan disclosures. You have the option to create a loan with or without a simulation. If the loan is not created the same day as the loan simulation, there is a possibility that the APR might exceed the allowable limit, causing an error in loan creation.

For optional parameters, do not pass an empty string or null value.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
1207-01	The total loan term is more than the maximum allowable limit, please validate the capital term or loan term values.
1207-02	The total loan term is less than the minimum allowable limit, please validate the capital term or loan term values.
1207-03	The loan APR cannot exceed 36%.The 36% MAPR is only applicable to individual customer loans, and there is currently no limit for business customer loans.
1207-04	The loan amount exceeds the maximum allowed loan amount configured for this subproduct.
1207-05	The loan term is less than the minimum configured.

Form Data

apiLogin

string

required

Defaults to AbC123-9999

Provider's web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Defaults to 4sb62fh6w4h7w34g

Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Defaults to 9999

Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

length between 1 and 60

Defaults to 984513-395483653-4483483478

A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: Max 60 characters
Example: "984513-395483653-4483483478"

providerTransactionId

string

An optional provider-generated ID for the API request.
Pattern: Max 60 characters
Example: "47823438032233777"

providerTimestamp

string

An optional provider-generated timestamp for the API request.
Pattern: Max 60 characters
Example: "2017-05-01 13:01:01"

loanTerm

int32

required

1 to 999999999

Defaults to 4

Number of installments to pay off the loan.
Pattern: Min 1 characters and max 9 characters.
Example: 4.

customerType

string

enum

Specifies whether the loan simulation is created for a consumer loan or business loan. If no value is provided, it defaults to INDIVIDUAL.

Allowed:

totalLoanAmount

number

required

0.01 to 99999999999999.98

Defaults to 10000

Total amount for the loan.
Pattern: Decimal number (14,2).
Example: "700.00".

capitalTerm

int32

required

1 to 999999999

Defaults to 2

Length of time between payments, in units specified by the subproduct. For example, if you specify “2” and the loan subproduct is set to weeks then installments will be due every two weeks.
Pattern: Max 9 digits.
Example: 2.

loanApplicationData

string

length between 1 and 4000

When using the loan simulation, you have the option to pass in comma-separated data from the user's application to store with the simulation for downstream analysis. If a loan is created, this associates the user’s application to the simulation and then to the loan.

firstInstallmentDueDate

date

Due date of the first installment has to be between the 1st and 28th of the month. This field does not apply to bi-weekly subproducts.

customerPmtRefNo

string

required

Defaults to 909675440

PRN for the customer’s primary account. Galileo uses the PRN to retrieve customer information, like business name, date of birth, SSN, address, etc. When the loan is created, the loan_id will be associated with this PRN.
Pattern: PRN
Example: "074103447228".

loanStartDate

date

Start date for the loan. This may be different from loan_creation_date.

applicationNumber

string

length between 1 and 100

Unique identifier that you generate for the loan application. This identifier is associated with loan simulations. You can give this identifier to customers for customer service purposes.

subProductId

string

required

length between 1 and 15

Defaults to 442824720

Identifier for the loan subproduct.
Pattern: Max 15 characters.
Example: "442824720".

Headers

response-content-type

string

enum

Defaults to json

Use xml or json to specify the type of response. The default value is xml. Use this instead of the standard accept header.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

200Success