API Reference
Postman collections ↗Bud Console ↗

Retrieve Benefits Totals

get
https://api-sandbox.thisisbud.com/v1/benefits/totals

Provides a customers' total income under each detected benefit type

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

Bud Customer identifier

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

string

The date from when results are to be retrieved in the format ISO-8601.

When ommited from the request, a default value of 30 days from before today's date will be used.

Example: 2022-02-28

string

The date up to when results are to be retrieved in the format ISO-8601.

When ommited from the request, a default value of today's date will be used.

Example: 2022-01-28

Responses

204

No transactions found

401

Unauthorised request

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago