PIpismo
Post interest accruals

Post interest accruals

The Pismo platform filters all accruals by accrual_status and, optionally, by start_date and end_date. For each accrual type in the results, it adds the values and posts one transaction for the total amount.

The status for each accrual filtered is changed to PROCESSED.

The 201 Created HTTP status response code indicates that the accruals were processed. However, the process that posts the transactions on the account's statement is asynchronous. To check if all transactions were created, check the Transaction created event to verify that a transaction was created for each tracking_id returned by the endpoint.

You can use start_date and end_date to restrict the search to accruals in a specific date range (where the accrual date indicates when the client issued the asset). If you do not provide either date field, then the search returns results from any date.

NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call Get OpenID access token with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message.

post/v1/accounts/{accountId}/interest-accruals

Request

  • Base URL
    https://sandbox.pismolabs.io/credit-cycle-interest-accruals
  • URL
    https://sandbox.pismolabs.io/credit-cycle-interest-accruals/v1/accounts/{accountId}/interest-accruals
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:5689

Account ID

Request body

start_datestring date

Start date. Format = YYYY-MM-DD.

end_datestring date

End date. Format = YYYY-MM-DD.

accrual_typestring

Accrual type enables selective posting, instead of posting all types at once. If not passed, the original behavior is preserved (posts all accrual types).

The following are some of the possible values. (This is not an exhaustive list.) REFINANCING OVERDUE WITHDRAWAL_INTEREST BILLPAYMENT_INTEREST OVERDRAFT_INTEREST FINANCIAL_TAX

processing_codestring

Processing code. Allows overriding the processing code used for posting the transaction, instead of using the one configured in accrual-type-post-config.

Notes:

  • If you pass processing_code, you must also pass the accrual_type field.
  • The provided processing code must exist in the transaction-flow service (validated via HTTP call).
  • If not passed, the processing code from the existing configuration (created using the Create accrual type post configuration endpoint) or from the default mapping is used.
processing_code_finestring

Processing code for fine. Allows overriding the processing code used specifically for posting FINE (penalty) when accrual_type is OVERDUE.

Notes:

  • Only allowed when accrual_type = OVERDUE and processing_code is passed.
  • If you pass processing_code_fine, you must also pass processing_code.

Special case: if accrual_type = OVERDUE and processing_code is passed, but processing_code_fine is not, and there are FINE accruals for the account, the endpoint returns a 409 Conflict error.

Example request

{
  "accrual_statuses": [
    {
      "status": "PENDING"
    }
  ],
  "start_date": "2024-01-01",
  "end_date": "2025-06-22",
  "accrual_type": "REFINANCING",
  "processing_code": "PROC123",
  "processing_code_fine": "FINE123"
}

Response

Created

Example response

{
  "authorizations": [
    {
      "accrual_type": "REFINANCING",
      "tracking_id": "18573154-bcb8-42c4-bd52-3f74e6939f47",
      "amount": 25.36
    }
  ]
}

Changes

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