PIpismo
Loan products

Create loan product

Creates a loan product.

This endpoint generates a Loan product created event.

post/v2/loan-products

Request

  • Base URL
    https://sandbox.pismolabs.io/lending
  • URL
    https://sandbox.pismolabs.io/lending/v2/loan-products
  • 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

collateral'NONE' | 'SINGLE' | 'COLLATERAL_MULTIPLE' required

Collateral

currencyinteger required

ISO 4217 currency code

product_namestring required

Open text that describes the product

product_type'BNPL' | 'PERSONAL' required

Loan product type

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.

interest_plan_idsstring[]

List of interest plan IDs

loan_activation_method'ON_BOOKING' | 'ON_DISBURSEMENT' | 'ON_DISBURSEMENT_OR_REPAYMENT' | 'ON_REPAYMENT'

Indicate when the system changes a loan to active status. Default is ON_DISBURSEMENT_OR_REPAYMENT. If disbursement method type is NONE, you cannot set to ON_DISBURSEMENT, and if set to ON_DISBURSEMENT_OR_REPAYMENT the system changes the loan status on repayment.

minimum_total_paymentnumber double

Minimum total payment for the loan product. Must be positive.

product_idstring

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.

repayment_calculation_method'RATES'

Method used to calculate the repayment amount

repayment_hierarchy_codestring

Repayment hierarchy code. Must be normalized (Unicode NFC), and may contain a UUID, or uppercase letters, numbers, and underscore.

Example request

{
  "collateral": "SINGLE",
  "currency": 999,
  "disbursement_method": {
    "type": "SINGLE"
  },
  "processing_codes": {
    "booking": [
      "000011"
    ],
    "disbursement": {
      "external": [
        "000011"
      ],
      "internal": [
        "000011"
      ]
    },
    "early_final_settlement": {
      "fee": [
        "000011"
      ]
    },
    "insurance": {
      "booking": [
        "000011"
      ],
      "repayment": [
        "000011"
      ]
    },
    "penalty_accruals": [
      "000011"
    ],
    "penalty_waiver": [
      "000011"
    ],
    "prepayment": {
      "fee": [
        "000011"
      ]
    },
    "present_value_discount": [
      "000011"
    ],
    "repayment": [
      "000011"
    ],
    "restructuring": [
      "000011"
    ]
  },
  "product_name": "Acme business loan",
  "product_type": "BNPL",
  "early_final_settlement": {
    "penalty": {
      "type": "PERCENTAGE",
      "value": 0.05
    },
    "lock_in_period": 9
  },
  "grace_period_days": 7,
  "interest_plan_ids": [
    "5a1b2c3d-4e5f-6789-abcd-1234567890ef"
  ],
  "loan_activation_method": "ON_BOOKING",
  "minimum_total_payment": 50,
  "parameters": {
    "overdue_threshold_days": 30,
    "stop_accrual_number_of_days": 60,
    "delinquency_closure_days": 90,
    "backdating_enabled": true,
    "max_backdating_window_days": 60
  },
  "prepayment": {
    "penalty": {
      "type": "PERCENTAGE",
      "value": 0.05
    },
    "reduce_option": [
      "INSTALLMENT",
      "TERM"
    ],
    "lock_in_period": 9
  },
  "product_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "repayment_calculation_method": "RATES",
  "repayment_hierarchy_code": "RH001"
}

Response

Loan Product created.

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.

Example response

{
  "product_id": "2717a296-124a-47cc-b2a1-91e80dc723eb"
}

Changes

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