Update Savings Goal Action

patch

https://api-sandbox.thisisbud.com/goals/v1/savings/{goal_id}/actions/{goal_action_id}

Update a savings goal action with a given goal_id and goal_action_id.

When a goal action is updated, we validate that the associated account has a balance that reflects this amendment. If the balance is not sufficient, the goal action will not be updated.

Path Params

goal_id

string

required

The ID of the savings goal.

Example: 81a68821-dca6-4771-80d4-002c7fce412e

goal_action_id

string

required

The ID of the savings goal action.

Example: 884d3e01-757c-4963-8e97-c1be109bbbcc

Body Params

amount

object

The amount of money being saved towards the savings goal.

The currency field is optional as it will default to the existing currency of the goal action; however, if it is supplied then it must be the same as the existing currency of the goal action.

credit_debit_indicator

string

enum

The credit/debit indicator of the amount. This indicates whether the amount has been added to or subtracted from the savings goal.

Example: credit

Allowed:

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200OK - The goal was updated successfully.

400The request contains an invalid payload.

401Unauthorized - The request was not authorised.

404Not Found - The goal ID or Goal Action ID could not be found

500Internal Server Error - An unexpected error occurred.