Loans

Get loan

Get a loan by its ID.

get/v2/loans/{loanId}

Request

Base URL
https://sandbox.pismolabs.io/lending
URL
https://sandbox.pismolabs.io/lending/v2/loans/{loanId}
Auth
HTTP bearer

Path parameters

loanIdstring uuid required

ID of the loan the operation applies to

Query parameters

presentValueboolean

Boolean value

Example:true

Retrieve the present value of the loan?

referenceDatestring date

Date value. Format = YYYY-MM-DD.

Example:2023-12-31

Reference date to calculate the present value of the loan

includeInsuranceHistoryboolean

Indicate true to get a response with the insurance history for loans in any state (ACTIVE, CANCELED, or SETTLED). When you use true for the query, each insured installment in repayment_schedule includes an insurance_premium_state field, and the response includes loan-level insurance_summary for loans that have an insurance policy. (The field is omitted entirely for uninsured loans). Also the response includes cancelled insurance and its installments. When absent or false, the response does not include these insurance-related fields. An invalid boolean value returns 400 with error code ELND1807. On the list endpoint, summarizeLoans=true takes precedence and this flag is ignored when summarizeLoans=true.

Response

Loan retrieved.

account_idinteger required

Account ID

created_atstring date-time required

Loan created date in UTC. Format = YYYY-MM-DDThh:mm:ss.SSSZ

loan_amountnumber double required

Loan amount

loan_idstring required

Custom ID for the loan. Must consist of uppercase alphanumeric characters and underscores.

product_idstring required

Loan product ID. Accepts either a lowercase UUID (e.g., "2717a296-124a-47cc-b2a1-91e80dc723eb") or an uppercase alphanumeric string with underscores (e.g., "MY_LOAN_PRODUCT_001"). If not provided during creation, a UUID is auto-generated.

start_datestring date required

Date loan was first active. Format = YYYY-MM-DD.

Loan status

PENDING-The loan has been created but has not yet been booked. Terms may still be under review or awaiting confirmation.

BOOKED-The loan has been approved and booked. The payment schedule is confirmed and the loan is ready for disbursement.

ACTIVE-The loan is active and in progress. Funds have been disbursed and the borrower is expected to make repayments according to the agreed schedule.

CANCELED-A repayment is no longer expected to be paid.

SETTLED-The loan has been fully repaid and is closed. No further repayments are expected.

RENEGOTIATED-The original loan terms have been modified after booking, typically due to a change in repayment conditions or borrower circumstances.

updated_atstring date-time required

Loan last updated date in UTC. Format = YYYY-MM-DDThh:mm:ss.SSSZ.

authorization_tracking_idstring uuid

Authorization tracking ID

contracted_installment_countinteger

Number of installments contracted when the loan was booked. For loans booked before this value was stored, it is the number of installments the loan has, cancelled installments included.

days_past_dueinteger

Number of calendar days elapsed since the real due date of the loan's most overdue repayment. Computed from repayments currently in a past due or overdue status. A value of 0 indicates the loan has no past due or overdue repayments.

external_idstring

External ID

grace_period_daysinteger

Number of calendar days after the installment due date during which late fees and delinquency are not applied. A value of 0 or omitted indicates no grace period.

loan_principal_amountnumber double

Principal portion of the loan amount, excluding interest, fees, taxes, and penalty

original_loan_idstring uuid

Original loan ID. When a loan is created from a restructure, this field contains the ID of the original loan that was restructured.

restructure_loan_idstring uuid

Restructure loan ID. When a loan has been restructured, this field contains the ID of the new loan created from the restructure.

total_expected_payment_amountnumber double

Total expected payment amount for the loan including principal, interest, fees, and penalty (if applied)

transactions_idsinteger[]

List of transaction IDs

Example response

{
  "account_id": 514751581,
  "created_at": "2026-09-03T17:58:35.520Z",
  "loan_amount": 2000,
  "loan_id": "MY_CUSTOM_LOAN_ID",
  "product_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "start_date": "2022-06-28",
  "status": "ACTIVE",
  "total_payable": {
    "amount_due": {
      "charge": 5,
      "fee": 10,
      "interest": 20,
      "penalty": 27,
      "principal": 2000,
      "tax": 10,
      "total": 2072
    },
    "arrears": {
      "charge": 5,
      "fee": 10,
      "interest": 20,
      "penalty": 27,
      "principal": 2000,
      "tax": 10,
      "total": 2072
    },
    "charge": 5,
    "fee": 10,
    "interest": 20,
    "penalty": 27,
    "principal": 2000,
    "tax": 10,
    "total": 2072
  },
  "total_paid": {
    "amount_paid": {
      "principal": 2000,
      "interest": 20,
      "fee": 10,
      "tax": 10,
      "charge": 5,
      "penalty": 27,
      "total": 2072
    }
  },
  "updated_at": "2024-03-15T13:00:00.000+00:00",
  "authorization_tracking_id": "4df987e3-8179-11ed-8209-06c7b022d1ee",
  "contracted_installment_count": 6,
  "days_past_due": 12,
  "disbursement": {
    "can_disburse_more": true,
    "remaining_to_disburse_amount": 700,
    "schedule": [
      {
        "amount": 300,
        "authorization_id": 2422410859,
        "date": "2025-11-13",
        "disbursement_account": {
          "account_id": 317890964,
          "account_type": "INTERNAL"
        },
        "id": "54efa995-66f1-4595-9934-5b92222faf37",
        "status": "PAID",
        "tracking_id": "003b3de8-c321-464c-a3dd-6009b8698325",
        "transactions_ids": [
          6354273849,
          982393773
        ]
      }
    ],
    "total_disbursed_amount": 300,
    "type": "SINGLE"
  },
  "external_id": "my_external_id",
  "grace_period_days": 7,
  "initial_amounts": {
    "principal": 2000,
    "interest": 20,
    "charge": 5,
    "tax": 10,
    "fee": 10,
    "penalty": 27,
    "total": 2072
  },
  "insurance_summary": {
    "installment_counts": {
      "canceled": 3,
      "paid": 3
    },
    "insurance_ever_active": true,
    "last_covered_date": "2023-12-31"
  },
  "loan_principal_amount": 1800,
  "original_loan_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "prepayments": [
    {
      "amount_paid": 1000,
      "created_at": "2026-06-15T10:00:00.000Z",
      "new_remaining_total": 4000,
      "penalty_amount_paid": 50,
      "prepayment_id": "73e45fd5-759f-4e04-a88a-7172fa948afa",
      "reduce_option": "INSTALLMENT",
      "settlement_date": "2026-06-15T10:00:00.000Z",
      "status": "REGISTERED",
      "updated_at": "2026-06-15T10:00:00.000Z"
    }
  ],
  "rates": {
    "annual_interest_rate": 12,
    "effective_annual_cost": 319.98,
    "effective_monthly_cost": 12.7,
    "interest_rate": 12
  },
  "repayment_schedule": [
    {
      "repayment_id": "5c075cc6-8dc2-4fe6-9ed7-cf5687d4e834",
      "transactions_ids": [
        6354273849,
        982393773
      ],
      "status": "SCHEDULED",
      "period": 1,
      "due_date": "2022-06-28",
      "real_due_date": "2025-06-28",
      "present_value_amount": 100,
      "present_value_discount": 100,
      "amount_due": {
        "charge": 5,
        "fee": 10,
        "interest": 20,
        "penalty": 27,
        "principal": 2000,
        "tax": 10,
        "total": 2072
      },
      "amount_paid": {
        "charge": 5,
        "fee": 10,
        "interest": 20,
        "penalty": 27,
        "principal": 2000,
        "tax": 10,
        "total": 2072
      },
      "initial_amount": {
        "charge": 5,
        "fee": 10,
        "interest": 20,
        "penalty": 27,
        "principal": 2000,
        "tax": 10,
        "total": 2072
      },
      "insurance": {
        "charge": 5,
        "fee": 10,
        "interest": 20,
        "penalty": 27,
        "principal": 2000,
        "tax": 10,
        "total": 2072
      },
      "insurance_premium_state": "PAID"
    }
  ],
  "restructure_loan_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "restructured_initial_amounts": {
    "principal": 2000,
    "interest": 20,
    "charge": 5,
    "tax": 10,
    "fee": 10,
    "penalty": 27,
    "total": 2072
  },
  "total_expected_payment_amount": 1100,
  "transactions_ids": [
    6354273849,
    982393773
  ]
}

Changes

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