Account interest

Get account interest [Beta]

Get the configuration changes recorded for an account with Partially update account interest.

The response lists up to 50 changes, from the most recently created to the oldest. Changes whose end_date has already passed are not included, and changes with a future effective_date are. An account whose interest was configured only with PUT /v1/interest/account/{accountId} has no recorded changes, so the request fails with 404.

Account identification. The token identifies the account—the path alone is not enough. Exactly one of x-account-id or x-external-account-id must be passed and must match the {accountId} path parameter. Otherwise the request is rejected (403 on a mismatch or when neither header is passed, 400 when both are).

Identifier validation. The ID encoded in the token is confirmed to exist by calling an external API before the configuration changes are read:

  • x-account-id: An Accounts API call confirms the account ID exists. If it does not, the request fails with 400 and account_id not found.
  • x-external-account-id: A Corporate API call resolves the external account ID to a Pismo account_id. If the external account ID does not exist, the request fails with 400 and external_account_id not found.

A 404 means the identifier is valid but the account has no active or future configuration changes. Any other failure of those APIs fails with 500.

get/v1/interest/account/{accountId}

Request

  • Base URL
    https://sandbox.pismolabs.io/interest-engine
  • URL
    https://sandbox.pismolabs.io/interest-engine/v1/interest/account/{accountId}
  • Auth
    HTTP bearer

Path parameters

accountIdstring required

Account ID. Must match the account encoded in the account token. This can be a Pismo account ID or an external account ID. A mismatch is rejected with 403 Forbidden. Maximum 60 characters.

Response

OK

account_idstring required

Pismo account ID of the account

external_account_idstring

External account ID, at most 60 characters, provided by the client system that owns the account. It cannot be passed directly in a request body—it's parsed from an external account ID token, and it's included in responses and events for accounts that have it stored.

Example response

{
  "account_id": "8080",
  "external_account_id": "account-xyz-987",
  "configuration_changes": [
    {
      "interest_parameters": {
        "benchmark": "FED",
        "margin_rate": 1.3,
        "margin": 0.05
      },
      "effective_date": "2026-11-01",
      "end_date": "2026-12-31",
      "created_at": "2026-10-14T15:04:05.123456",
      "metadata": {
        "campaign": "year-end-promotion"
      }
    },
    {
      "interest_parameters": {
        "taxes_exemption": true
      },
      "effective_date": "2026-09-01",
      "created_at": "2026-08-20T09:30:00.654321",
      "metadata": {}
    }
  ]
}

Changes

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