GRgreendot
CategorizeTransaction

Get a summary of categorized transactions for a user

Retrieves a summary of the user's categorized transactions within the specified date range.

get/programs/{programCode}/accounts/{accountIdentifier}/userCategory/summary

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code identifying the BaaS program context.

accountIdentifierstring required

The unique identifier for the account whose transaction summary is being retrieved.

Query parameters

startDatestring

The start date for the summary (optional).

endDatestring

The end date for the summary (optional).

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging. Should be a GUID.

Response

OK

totalAmountnumber double

The total amount for all categorized transactions in the summary.

Example response

{
  "userCategories": [
    {
      "userCategoryDescription": "Gas",
      "userCategoryKey": 1,
      "userCategory": "Gas"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.