PIpismo
Loans

Book loan

Books a loan with the configuration set up in the loan product.

This endpoint generates a Loan booked event and a Platform authorization created event.

post/v2/loans

Request

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

Request body

account_idinteger required

Account ID

installment_plan_idstring uuid required

ID of the installment plan

loan_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.

number_of_installmentsnumber required

Number of installments

amountnumber double

Booking amount

metadataV2Metadata

Additional 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.

Example request

{
  "account_id": 514751581,
  "installment_plan_id": "5c075cc6-8dc2-4fe6-9ed7-cf5687d4e834",
  "loan_product_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "amount": 1000
}

Response

Loan booked.

loan_idstring required

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

Example response

{
  "loan_id": "MY_CUSTOM_LOAN_ID"
}

Changes

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