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. Please note, currently only UK benefits are supported.

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": "NATWEST DWP DLA GBR",
      "provider": "Natwest",
      "date": "2022-03-21T01:00:00+0100",
      "amount": {
        "amount": "333.28",
        "currency": "GBP"
      },
      "credit_debit_indicator": "Credit",
      "benefit": {
        "type": "disability_living_allowance",
        "display_name": "Disability Living Allowance"
      }
    }
  ],
  "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-Customer-Secret: <customer_secret>' \ # Not required for hosted customers
     --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.

A 401 response would indicate that you are not authorised to make this request, if you believe this to be a mistake or are receiving persistent 500 responses please raise a support request support request.

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