Loan

Get Loan Status

Use the Get Loan Status endpoint to get the most recent information on a loan.

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

post/1.0/getLoanStatus

Request

  • Base URL
    lending-{corename}.{env}.gpsrv.com/lending/ (relative, and the document’s source URL is not known)
  • URL
    lending-{corename}.{env}.gpsrv.com/lending/1.0/getLoanStatus
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

providerIdinteger required

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

transactionIdstring required

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"

providerTransactionIdstring

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

providerTimestampstring

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

loanIdstring required

Unique identifier for the loan. Pattern: Max 30 characters Example: "450825953".

subProductIdstring required

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

Response

Success

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A Galileo-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Example response

{
  "response_data": {
    "loan_apr": 15,
    "interest_rate": 15,
    "rate_type": "FIXED",
    "installment_amount": 1740.34,
    "next_installment_amount": 1740.34,
    "next_installment_due_date": "2022-02-01",
    "principal_balance": 10000,
    "loan_status": "ACTIVE",
    "payoff_amount": 10000,
    "loan_closed_date": "2022-06-21",
    "per_diem_interest_amount": 1.61363,
    "number_payments_remaining": 6,
    "loan_payment_status": "OCUR",
    "projected_maturity_date": "2022-07-01",
    "loan_start_date": "2022-06-02"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.