Benefits Finder

Retrieve Benefits Transactions

The GET v1/benefits endpoint provides a list of a customer's benefit-based transactions found within their connected accounts and transactions.

This endpoint will return a list of the given customer's benefit transactions between the provided X-From date and X-To date headers. An example of a 200 response can be seen below.

{
  "operation_id": "v1_benefits_get",
  "data": [
    {
      "transaction_id": "fdcc55c6-f347-4abc-8c66-61ff290d8bd4",
      "account_id": "fdcc55c6-f347-4abc-8c66-61ff290d8bd4",
      "transaction_description": "TANF PGRM 34267 US",
      "provider": "BankOfBud",
      "date": "2022-03-21T01:00:00+0100",
      "amount": {
        "amount": "333.28",
        "currency": "USD"
      },
      "credit_debit_indicator": "Credit",
      "benefit": {
        "type": "federal_stimulus",
        "display_name": "Federal Stimulus"
      }
    }
  ],
  "metadata": {
    "from": "2022-03-19",
    "to": "2022-04-19",
    "results": 1
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/v1/benefits \
     --header 'X-Client-Id: <client_id>' \
     --header 'X-Customer-Id: <customer_id>' \
     --header 'X-From: 2023-01-01' \
     --header 'X-To: 2024-01-01' \
     --header 'accept: application/json'

This response will contain a list of benefit transactions including anaccount_id, transaction description, date, amount, benefit type and a display_name. The display_name is intended to be in plain English, this is the value that we recommend displaying to a customer.

In the case that no benefit transactions can be found you will receive a 204 response with an empty body.

If you receive a 400 response like below, please check the headers you're sending in the request before trying again. If you continue to receive an error please consult the error responses guide.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.