Accruals

Update interest accrual statuses

Update the statuses of one or more interest accruals.

You can use accrual type and accrual IDs to filter interest accruals.

You can change an interest accrual's status to PENDING, STOP_ACCRUAL, or SETTLED. If the current status is PROCESSED, it cannot be changed. As a result, this endpoint could return two lists, one for updated accruals and one for not updated accruals.

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/v3/accounts/{accountId}/interest-accruals

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v3/accounts/{accountId}/interest-accruals
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Request body

Example request

{
  "accruals": [
    {
      "interest_accrual_ids": [
        1,
        2,
        3,
        4
      ],
      "accrual_type": "OVERDUE",
      "new_status": "SETTLED"
    }
  ]
}

Response

Ok

updated_idsinteger[]

ID's of interest accruals that have been updated.

not_updated_idsinteger[]

ID's of interest accruals that have not been updated, because, for example, the status cannot be changed if it is already PROCESSED.

Example response

{
  "updated_ids": [
    1,
    2,
    3
  ],
  "not_updated_ids": [
    5,
    6
  ]
}

Changes

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