Retrieve Money Management

get deprecatedhttps://api-sandbox.thisisbud.com/v1/signal/money-management

Provides a list of potential scenarios where a customer might suffer some financial expense that cover the following:

❗️
Deprecation:
Support will cease for this endpoint on the 1st of December 2023 - please complete your migration to the Retrieve Actionable Insights endpoints by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com.

Money Management	Description
`overdraft`	Account is overdrawn (note that credit cards will not trigger this warning).
`cannot_cover_bills`	The total upcoming payments for exceeds the current balance. The time range used for analysing past payments is `(X-From, X-Today)` and the period used for predicting upcoming payments is `(X-Today, X-To)`.
`late_income`	A regular incoming payment was expected to be received on the account and hasn't yet.
`late_payment`	A regular outgoing payment that was expected to come out of the account on a specific date but has been paid after expected date.
`regular_payment_changed`	The value of a regular payment has increased or decreased between the oldest and newest instance.
`suspected_duplicate_charge`	A duplicate transaction is one of more transactions that are debit transactions, have a non-zero booking time, and have a non-zero amount. They must also have matching `account_id`, `transaction_reference`, `merchant_id` (if one exists), `amount`, `currency`, `date`, `booking_datetime`.
`regular_monthly_income_change`	The value of a regular income has increased or decreased based on the previous months income. As this is comparing income over whole months, only complete months are considered in the provided date range. For instance, if `X-From=2022-01-05` and `X-To=2022-04-05` then the range considered by this warning will be `(2022-01-01, 2022-03-31)`. In addition, the default treshold for a difference in amounts to trigger this warning is 10%.

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).

X-From

string

Date (YYYY-MM-DD) from which the transactions should be returned from, this works in pair with the 'X-To' parameter

X-To

string

Date (YYYY-MM-DD) from which the transactions should be returned to, this works in pair with the 'X-From' parameter

X-Today

string

Date (YYYY-MM-DD) to treat as the current day. Use this with X-From and X-To to find historical warnings (e.g. warnings that you would have received last week)

X-Delta

number

≥ 0

Defaults to 3

Number of days error to match regular payments when they could be off by a few days from month to month. E.g. if your predicted rent payment is on 25th but you paid it on 23rd, a delta of 2 would treat your predicted transaction for 25th as Booked/Pending.

Responses

Response body

object

operation_id

string

required

v1_signal_money_management_get

data

array of objects

required

Money Management	Description
`overdraft`	Account is overdrawn (note that credit cards will not trigger this warning).
`cannot_cover_bills`	The total upcoming payments for exceeds the current balance. The time range used for analysing past payments is `(X-From, X-Today)` and the period used for predicting upcoming payments is `(X-Today, X-To)`.
`late_income`	A regular incoming payment was expected to be received on the account and hasn't yet.
`late_payment`	A regular outgoing payment that was expected to come out of the account on a specific date but has been paid after expected date.
`regular_payment_changed`	The value of a regular payment has increased or decreased between the oldest and newest instance.
`suspected_duplicate_charge`	A duplicate transaction is one of more transactions that are debit transactions, have a non-zero booking time, and have a non-zero amount. They must also have matching `account_id`, `transaction_reference`, `merchant_id` (if one exists), `amount`, `currency`, `date`, `booking_datetime`.
`regular_monthly_income_change`	The value of a regular income has increased or decreased based on the previous months income. As this is comparing income over whole months, only complete months are considered in the provided date range. For instance, if `X-From=2022-01-05` and `X-To=2022-04-05` then the range considered by this warning will be `(2022-01-01, 2022-03-31)`. In addition, the default treshold for a difference in amounts to trigger this warning is 10%.

Money Management Response*

object

type

string

required

Money Management responses returned by API endpoint.

overdraft cannot_cover_bills late_income late_payment regular_payment_changed suspected_duplicate_charge regular_monthly_income_change

details

required

metadata

object

required

Bud money management metadata

results

integer

required

Number of results returned.

from

string

required

From date used in query (YYYY-MM-DD)

string

required

To date used in query (YYYY-MM-DD)

today

string

required

Today date used in query (YYYY-MM-DD)

400

Bad Request that fails validations on headers & payload

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

403

Forbidden

5XX

An unexpected error occurred on the server side

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.thisisbud.com/v1/signal/money-management \
3
     --header 'X-Delta: 3' \
4
     --header 'accept: application/json'

Choose an example:

application/json

200The request was successfully processed