Create Savings Goal

post

https://api-sandbox.thisisbud.com/goals/v1/savings

Create a savings goal for the given account id.

Of the fields target_amount, target_date and recurrent_amount, only two are required. If two are supplied then the third parameter will be calculated in the response.

For example: If the date the goal is created is 2023-01-01, if a savings goal is created with the target_amount of £110, and the target_date is 2023-12-01, then the recurrent amount will be £10.

When performing this calculation, it is asusmed that a customer is not going to deposit their first savings payment within the month of creating the goal. If this is the desired behaviour however, all three parameters can be supplied and the endpoint will accept this.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name of the savings goal.

Example: Holiday

account_id

string

required

The account id of the account the savings goal is associated with.

Example: RxsYshVGded4JeilkXgWKdXA

target_amount

object

The target amount of money to be saved to defining the savings goal.

This field is optional, however if it is not supplied, then target_date and recurrent_amount must be supplied.

If target_amount, target_date and recurrent_amount are all supplied, they will be validated to ensure the goal is achievable under these conditions.

target_date

string

The target date, in the format ISO-8601 to reach the savings goal.

This field is optional, however if it is not supplied, then target_amount and recurrent_amount must be supplied.

If target_amount, target_date and recurrent_amount are all supplied, they will be validated to ensure the goal is achievable under these conditions.

Example: 2023-01-17

recurrent_amount

object

The amount of money to be saved each month to reach the savings goal.

This field is optional, however if it is not supplied, then target_amount and target_date must be supplied.

If target_amount, target_date and recurrent_amount are all supplied, they will be validated to ensure the goal is achievable under these conditions.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

Bud Customer identifier

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

Responses

201Created - The goal was created successfully.

400Bad Request - The request was invalid.

401Unauthorized - The request was not authorised.

404Not Found - The account ID provided was not found.

500Internal Server Error - An unexpected error occurred.