Prepayment

Create prepayment record

Creates a prepayment record containing one or multiple repayments.

This endpoint generates a Prepayment created event.

Note: This endpoint requires an account-specific access token.

post/v2/prepayments

Request

Base URL
https://sandbox.pismolabs.io/lending
URL
https://sandbox.pismolabs.io/lending/v2/prepayments
Auth
HTTP bearer

Headers

Idempotency-Keystring uuid

Optional UUID that makes the request idempotent, enabling you to retry it multiple times while the system processes it only once.

Request body

repayment_idsstring[] required

List of repayments to be paid in the current prepayment

expiration_datestring date

Expiration date of the prepayment. Format = YYYY-MM-DD.

metadataPrepaymentMetadata

Additional prepayment information

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

reference_datestring date

Reference date of the installment. Format = YYYY-MM-DD.

Example request

{
  "repayment_ids": [
    "c04fd22b-7d9c-4099-aaf4-9ee002b5a6a7",
    "jdu55ks2-7d9c-4099-aaf4-9ee002tkl554"
  ],
  "expiration_date": "2025-04-28",
  "reference_date": "2025-04-14"
}

Response

Prepayment created.

expected_amountnumber double

Expected amount to be paid

expiration_datestring date

Date after which the pending prepayment expires and its installments revert to their base status. Defaults to reference_date (or today when absent) plus 30 days. Format = YYYY-MM-DD.

prepayment_idstring uuid

Pismo-generated UUID identifying the prepayment

reference_datestring date

Reference date applied to the prepayment (pricing base); null when not provided in the request. Format = YYYY-MM-DD.

Example response

{
  "allocation_summary": [
    {
      "loan_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "loan_start_date": "2025-01-15T00:00:00.000Z",
      "installment_amount": 156.54,
      "minimum_total_payment_delta": 43.46
    },
    {
      "loan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "loan_start_date": "2025-03-01T00:00:00.000Z",
      "installment_amount": 200,
      "minimum_total_payment_delta": 0
    }
  ],
  "expected_amount": 100,
  "expiration_date": "2026-08-31",
  "prepayment_id": "c04fd22b-7d9c-4099-aaf4-9ee002b5a6a7",
  "reference_date": "2026-08-01"
}

Changes

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