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.

When X-From is omitted from the request, a default value of 30 days from before today's date will be used.
When X-To is omitted from the request, a default value of today's date will be used.

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

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

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.

string

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

string

Transaction from date, this works in pair with the 'X-To' parameter

string

Transaction to date, this works in pair with the 'X-From' parameter

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 about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?