---
title: "Get Loan Payment Schedule"
method: POST
path: "/1.0/getLoanPaymentSchedule"
tags: ["Loan"]
---

# Get Loan Payment Schedule

`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

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `apiLogin` string, required: Provider's web service username, as provided by Galileo for the requesting IP address. Pattern: Max 50 characters Example: `"AbC123-9999"`
  - `apiTransKey` string, required: Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`
  - `providerId` integer, required: Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `9999`
  - `transactionId` string, 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"`
  - `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"`
  - `loanId` string, required: Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.
  - `subProductId` string, required: Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.

## Response `200`

Success

- object
  - `status_code` integer, nullable, required: The response status code. May return a string for some statuses.
  - `status` string, nullable, required: The condition of a process or response
  - `processing_time` number, float, nullable, required: The time elapsed in processing the transaction
  - `echo` object, nullable, required: A structure that contains transaction ID information
    - `transaction_id` string, nullable, required: An ID that represents an API transaction
    - `provider_timestamp` string, date-time, nullable, required: Store a related timestamp for reporting and troubleshooting purposes
    - `provider_transaction_id` string, nullable, required: Secondary transaction identifier (generated by a provider)
  - `system_timestamp` string, date-time, nullable, required: A system generated timestamp
  - `rtoken` string, nullable, required: A Galileo-generated ID used for tracking
  - `errors` string[]: A list of errors generated while the request was processed
  - `response_data` object, nullable, required: A structure for the response data. It can be empty but usually will contain information.
    - `total_principal_paid` number, required: Principal amount of the loan that is paid off.
    - `total_interest_paid` number, required: Interest amount of the loan that is paid off.
    - `total_fees_paid` number, required: Total amount paid toward fees, including the origination fee and late fees.
    - `late_fee` number, required: Total amount owed on late fees.
    - `payments_schedule` object[]: List of payment schedule.
      - `scheduled_installment_number` integer, required: Indicates the number of the installment.
      - `scheduled_due_date` string, date, required: Date that the payment for this installment is due.
      - `scheduled_amount_due` number, required: Total amount owed for this installment, including the principal amount and interest.
      - `scheduled_principal_amount` number, required: Amount owed on the principal loan for this installment.
      - `scheduled_interest_amount` number, required: Amount owed on the loan interest for this installment.
      - `scheduled_late_fee_due` number, required: Late fee amount due for this installment. If no late fee is due, the amount is 0.00.
      - `scheduled_balance_amount` number, required: 2000.00
    - `payments_history` object[]: Contains the record for each payment previously made on the loan. If none of the installments are paid, you will not receive the details for `payments_history`.
      - `hist_payment_date` string, date, required: Date that this payment was made.
      - `hist_payment_amount` number, required: The total amount paid on this payment.
      - `hist_payment_principal` number, required: Amount paid on the principal loan amount for this payment.
      - `hist_payment_interest` number, required: Amount paid on the loan interest for this payment.
      - `hist_payment_fees` number, required: mount paid on loan fees for this payment.
      - `scheduled_balance_amount` number, required: Remaining balance after this payment was made.
      - `hist_payment_source` 'USRP' | 'SYSP' | 'CRDP' | 'CSRP' | 'IVRP' | 'DFRL' | 'DWRO' | 'PCRP' | 'MCRP' | 'RCRP' | 'ADLP'

---

[API](https://skmtc.dev/galileo-ft/apis/loan-api.md) - [All operations](https://skmtc.dev/galileo-ft/apis/loan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/galileo-ft/apis/loan-api/revisions/64783a0f7d15?raw)