PIpismo
Loans

Cancel loan

Cancels a loan.

This endpoint generates a Loan updated event.

post/v2/loans/{loanId}/cancel

Request

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

Path parameters

loanIdstring uuid required

ID of the loan the operation applies to

Headers

Idempotency-Keystring uuid required

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

Request body

tracking_idstring uuid required

Tracking ID

metadataCancelLoanV2Metadata

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

refund_paid_repaymentsboolean

Refund paid repayments upon loan cancellation?

Example request

{
  "tracking_id": "003b3de8-c321-464c-a3dd-6009b8698325",
  "processing_code": {
    "booking": "000011",
    "penalty_waiver": "000011",
    "repayment": "000011"
  },
  "refund_paid_repayments": true
}

Response

Cancellation accepted

canceled_loan_idstring required

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

reversal_authorization_idnumber required

Authorization ID

reversal_tracking_idstring uuid required

Authorization tracking ID

Example response

{
  "canceled_loan_id": "MY_CUSTOM_LOAN_ID",
  "reversal_authorization_id": 123456789,
  "reversal_tracking_id": "4df987e3-8179-11ed-8209-06c7b022d1ee"
}

Changes

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