Create Loan

post

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

Use the Create Loan endpoint to create a loan offering for a customer. Loan subproducts are configured for your installment loans product and are assigned a subproduct ID. Ensure you have the required customer data to create a loan.

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

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"

customerPmtRefNo

string

required

^([0-9]{12}|[0-9]{16})$

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

subProductId

string

required

length between 1 and 15

Defaults to 442824720

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

simulationId

string

length between 1 and 30

Unique identifier associated with each loan simulation returned by the Simulate Loan endpoint. Required when creating a loan from a simulation. Do not pass the following fields when the simulationId is provided: totalLoanAmount, loanTerm, and capitalTerm.
Pattern: Max 9 characters.
Example: "450825953".

ssn

string

required

length between 9 and 9

^[0-9]*$

Defaults to 222554444

Loan applicant’s SSN.
Pattern: Exactly 9 digits, no hyphens or other characters.
Example: "222554444".

phone

string

length between 10 and 10

Loan applicant’s phone number.
Pattern: Exactly 10 digits, no hyphens or other characters.
Example: "1115553333".

string

length between 3 and 63

Loan applicant’s email address.
Pattern: Email address, 3–63 characters.
Example: "[email protected]".

address1

string

required

length between 4 and 40

Defaults to 33 Maple Street

Loan applicant’s first address line. Cannot be a P.O. box. Validation rules for address1.
Pattern: 4–40 alphanumeric characters.
Example: "33 Maple Street".

address2

string

length between 1 and 30

Loan applicant’s second address line.
Pattern: Max 30 characters.
Example: "#4B".

city

string

required

length between 1 and 30

Defaults to Salt Lake City

Loan applicant’s city.
Pattern: Max 30 characters: letters, spaces, hyphen and period.
Example: "Salt Lake City".

state

string

required

length between 2 and 2

Defaults to UT

Loan applicant’s state or province.
Pattern: 2-character state or province abbreviation.
Example: "UT".

postalCode

string

required

length between 5 and 10

^[a-zA-Z0-9\-\ ]*$

Defaults to 84121

Loan applicant’s postal code (ZIP code).
Pattern: Min 5 characters and max 10 characters (12345, 12345-1234, or K1A-1A1).
Example: "84121".

countryCode

string

enum

required

Defaults to 840

Loan applicant’s country. Three-digit UN M49 country code. Currently the only allowed value is 840 for the USA.
Pattern: 3-digit country code.

Allowed:

occupation

string

length between 1 and 25

Loan applicant’s occupation.
Pattern: Max 25 characters.
Example: "Project Manager".

employer

string

length between 1 and 200

Loan applicant’s employer.
Pattern: Max 200 characters.
Example: "Kroger Food & Drug".

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.

totalLoanAmount

number

0.01 to 99999999999999.98

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

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.

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.

loanStartDate

date

yyyy-MM-dd

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

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/xml

application/json

200Success