PIpismo
Refinancing

Update agreement original rate

Update a payment agreement's use_original_rate attribute.

Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

patch/statements-v2/v4/accounts/{accountId}/installment-payments/{paymentsAgreementsId}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v4/accounts/{accountId}/installment-payments/{paymentsAgreementsId}
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

paymentsAgreementsIdinteger required
Example:1

Payment agreement ID

Request body

use_original_rateboolean

Set to true if the original installment rate should be used to generate accruals. Set to false, otherwise. The original installment rate is the payment agreement contract interest rate. So, if this field is set to true, this rate is used instead of the transaction category interest rate when a payment agreement installment is due.

Response

Ok

previous_use_original_rateboolean

Previous value for use_original_rate.

current_use_original_rateboolean

Current value for use_original_rate.

messagestring

Update message

Example response

{
  "previous_use_original_rate": true,
  "message": "This contract’s overdue transactions accrue using the original rate."
}

Changes

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