The Spending endpoint works on top of the Data API, by analysing the user's transactions and recognising regular committed spending.
The Spending endpoint
Example response from Spending API
{
"transaction_history_span_days": 61,
"expenditures": [
{
"name": "Direct debit NWL & ESW WATER",
"frequency": "monthly",
"classification_category": [
"Bills and Utilities",
"Utilities"
],
"previous_payment_timestamp": "2020-05-27T00:00:00Z",
"predicted_next_payment_timestamp": "2020-06-27T00:00:00Z",
"predicted_next_payment_amount": -20.0,
"average_amount": -20.0,
"minimum_amount": -20.0,
"maximum_amount": -20.0,
"supporting_transactions": [
{
"transaction_id": "LONG_STRING_OF_LETTERS_AND_NUMBERS",
"description": "Direct debit NWL & ESW WATER",
"amount": -20.0,
"currency": "GBP",
"transaction_category": "DIRECT_DEBIT",
"timestamp": "2020-05-27T00:00:00Z",
"transaction_type": "Debit",
"merchant_name": "",
"transaction_classification": [
"Bills and Utilities",
"Utilities"
],
"meta": {
"provider_category": "PaymentType: D7",
"transaction_type": "Debit",
"provider_id": "LONG_STRING_OF_LETTERS_AND_NUMBERS"
}
},
{
"transaction_id": "LONG_STRING_OF_LETTERS_AND_NUMBERS",
"description": "Direct debit NWL & ESW WATER",
"amount": -20.0,
"currency": "GBP",
"transaction_category": "DIRECT_DEBIT",
"timestamp": "2020-04-27T00:00:00Z",
"transaction_type": "Debit",
"merchant_name": "",
"transaction_classification": [
"Bills and Utilities",
"Utilities"
],
"meta": {
"provider_category": "PaymentType: D7",
"transaction_type": "Debit",
"provider_id": "LONG_STRING_OF_LETTERS_AND_NUMBERS"
}
}
]
},
*The above example is shown only for the visual demonstration of the Spending API.
If you need more information
Check out our comprehensive API documentation with more details.