Loan

Get Loan Transaction History

Use Get Loan Transaction History endpoint to provide a complete history of the transaction data associated with a particular business or consumer loan. Transaction data includes but is not limited to when a loan is created and funds disbursed, when fees were assessed, charged, waived, or reversed, and when a loan was charged off.

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

post/1.0/getLoanTransactionHistory

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/getLoanTransactionHistory
  • 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"

sortKey'id'

Sort key of the loan. Pattern: Max 30 characters. Example: 123456.

pageinteger

Number of the page to retrieve. Pattern: Integar value of 1 or greater. Example: 1.

recordCntinteger

Maximum number of records per page to be returned. Pattern: Max 3 characters. Example:100.

sortDirection'ASC' | 'DESC'

Sort the record in ascending or descending order. Possible values: ASC - Ascending or DESC - Descending. Default: ASC.

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": {
    "principal_balance": 10000,
    "loan_transactions": [
      {
        "loan_transaction_id": "450825953",
        "transaction_code": 9006,
        "transaction_amount": 100,
        "reversal_flag": true,
        "charge_code": 8,
        "loan_transaction_date": "2023-01-01",
        "loan_transaction_effective_date": "2023-01-01",
        "loan_payment_number": "123",
        "payment_source": "USRP",
        "total_charge_off_amount": 100,
        "loan_status_reason_code": 1010,
        "amount_type": 4
      }
    ],
    "page": 1,
    "total_record_count": 10,
    "number_of_pages": 5
  }
}

Changes

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