GAgalileo-ft
Loan

Get Loan Payment Schedule

Use the Get Loan Payment Schedule endpoint to get a history of payments made on the loan along with a real-time view of future payments owed. This endpoint reflects changes to the installment amount that can occur for various reasons, like a merchant refund. Get Loan Payment Schedule returns the updated amount owed on future installments, but the due dates remain the same as provided in the amortization schedule.

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

post/1.0/getLoanPaymentSchedule

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/getLoanPaymentSchedule
  • 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": {
    "late_fee": 2000,
    "payments_schedule": [
      {
        "scheduled_installment_number": 2,
        "scheduled_amount_due": 857.47,
        "scheduled_principal_amount": 2,
        "scheduled_interest_amount": 836.67,
        "scheduled_late_fee_due": 2000
      }
    ],
    "payments_history": [
      {
        "hist_payment_amount": 2000,
        "hist_payment_principal": 2000,
        "hist_payment_interest": 2000,
        "hist_payment_fees": 2000,
        "scheduled_balance_amount": 2000
      }
    ]
  }
}

Changes

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