Create Savings Goal Action

post

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

Creates a savings goal action for the given goal_id.

Savings goal actions represent the transfer of the savings payment into the associated account.

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

Path Params

goal_id

string

required

The ID of the savings goal.

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

Body Params

amount

object

required

The amount of money being saved towards the savings goal.

credit_debit_indicator

string

enum

required

The credit/debit indicator of the amount. This indicates whether the amount is 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.

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

201Created - The goal action was created successfully.

400The request contains an invalid payload.

401Unauthorized - The request was not authorised.

404Not Found - The goal ID could not be found.

500Internal Server Error - An unexpected error occurred.