ClearBank

Interest configuration

Interest configuration

You can update the interest configuration of your existing savings accounts. This functionality is enabled on a per-client basis, so please reach out if you'd like to use it.

The initial interest configuration ID is usually set during account creation. You can later update it using the POST /interest/v1/accounts/{accountId}/configurations endpoint to a different interest configuration ID specified in the interestConfigurationId field. You can request a new configuration ID from your usual ClearBank contact.

The interest rate will apply for the whole of the day on which it is set. Interest is calculated in the early hours of the morning based on data from midnight UK time.

You can retrieve all past, current, and future interest configurations by using the GET /interest/v1/accounts/{accountId}/configurations endpoint.

Daily interest example

If you update an interest product at 15:00 on Tuesday, all of Tuesday's interest, even before 15:00, will be calculated at the new interest rate. The Interest Paid and Transaction Settled webhooks will notify you of the amount of interest paid each day.

This diagram shows the message flow:

A message flow diagram describing the above process of setting the daily interest configuration.

Monthly interest example

If you update an interest product at 14:00 on the 5th, interest from the 1st to the 4th will be calculated at the previous rate at the end of the month. Interest from the 5th until the end of the month will be calculated using the new rate. The Interest Paid and Transaction Settled webhooks will notify you of the amount of interest paid at the end of the month.

This diagram shows the message flow:

A message flow diagram describing the above process of setting the monthly interest configuration.

Update interest configuration

post/interest/v1/accounts/{accountId}/configurations

This endpoint is used to update an interest configuration for a savings account.

Parameters

  • accountId string, path, Required

    The unique identifier for the account. This can be retrieved from GET /v3/Accounts.

  • Authorization string, header, Required

    Your API Token, obtained from the ClearBank Portal.

  • DigitalSignature string, header, Required

    Signed hash of the body of the request. The hash is signed by your private key.

  • X-Request-Id string, header, Required

    A unique identifier for the request; valid for 24 hours, max length 83.

Request Payload (application/json)

  • interestConfigurationId string

    The UUID indicating the interest configuration for the account. If you don't have this, speak to your Client Director.

request

{
"interestConfigurationId": "5C35D48D-0R3D-47BE-9F54-I9F3328L7V2A"
}
Code copied

Response (application/json)

  • 201 Created
  • 400 Bad Request
  • 404 Not Found
  • 409 Conflict

Created

{
"accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
"interestConfigurationId": "24df1e52-24d9-4bda-86af-c81a7d1932b1",
"effectiveFrom": "2025-08-24"
}
Code copied

Bad Request

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Code copied

Not Found

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Code copied

Conflict

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Code copied

Get an account's interest configurations

get/interest/v1/accounts/{accountId}/configurations

This endpoint is used to retrieve past, current, and future interest configurations for a savings account.

Parameters

  • AccountId string, path, Required

    The unique identifier for the account. This can be retrieved from GET /v3/Accounts.

  • Authorization string, header, Required

    Your API Token, obtained from the ClearBank Portal.

Response (application/json)

  • 200 OK
  • 400 Bad Request
  • 404 Not Found

OK

{
"future": [
{
"effectiveFrom": "2025-08-24",
"interestConfigurationId": "24df1e52-24d9-4bda-86af-c81a7d1932b1",
"name": "string"
}
],
"current": {
"effectiveFrom": "2025-08-24",
"interestConfigurationId": "24df1e52-24d9-4bda-86af-c81a7d1932b1",
"name": "string"
},
"past": [
{
"effectiveFrom": "2025-08-24",
"interestConfigurationId": "24df1e52-24d9-4bda-86af-c81a7d1932b1",
"name": "string"
}
]
}
Code copied

Bad Request

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Code copied

Not Found

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Code copied