Enriched Bank Data#

View as Markdown

Enriched Bank Data is a paid product built on top of the free account information layer. It provides enrichment on transaction-level data — adding structured merchant names, locations, URLs, and purpose categories to raw transaction records.

For pricing or to enable the product, contact bank-account-data-sales@gocardless.com. For technical or data-related questions, open a support request.

Integration#

Once Enriched Bank Data is enabled, the enrichment layer is returned alongside the standard account information layer — there is no need to call the standard accounts endpoints separately.

If you followed the Quickstart Guide, you only need to switch to the Enriched Bank Data (/premium) endpoints at Step 6: Access accounts, balances, and transactions:

curl -X GET "https://bankaccountdata.gocardless.com/api/v2/accounts/premium/065da497-e6af-4950-88ed-2edbc0577d20/transactions/" \
  -H "accept: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Example response:

{
  "transactions": {
    "booked": [
      {
        "transactionId": "2020111101899195-1",
        "transactionAmount": {
          "currency": "EUR",
          "amount": "2500.00"
        },
        "bankTransactionCode": "TRNSF",
        "bookingDate": "2022-09-01",
        "valueDate": "2022-09-01",
        "remittanceInformationUnstructured": "GoCardless. Slry for August",
        "enrichment": {
          "displayName": "GoCardless",
          "branchDisplayName": "",
          "location": {
            "address": "Sutton Yard, Goswell Rd",
            "city": "London",
            "postalCode": "EC1V 7EN",
            "country": "UK",
            "lat": 51.91419,
            "lon": 0.99671
          },
          "urls": {
            "website": "https://gocardless.com/",
            "favicon": "https://gocardless.com/favi",
            "logo": "https://gocardless.com/logo"
          },
          "transactionType": "Transfer",
          "purposeCategory": ["Income", "Salary"],
          "purposeCategoryId": "046a4092-7222-4da8-b588-790571878c34"
        }
      }
    ]
  }
}

Field reference#

Key	Type	Description
`displayName`	String	Clean display name of the counterparty
`branchDisplayName`	String	Clean display name of the counterparty's branch, if applicable
`location`	Object	Structured address: `address`, `city`, `region`, `postalCode`, `country` (two-letter code), `lat`, `lon`
`urls`	Object	URLs for the counterparty: `website`, `favicon`, `logo`
`transactionType`	String	Transaction type. One of: `PAYMENT`, `TRANSFER`, `REFUND`, `ATM`, `FEES/CHARGES`, `TAXES`, `INTEREST`, `EXCHANGE`, `SALARY`, `OTHER`
`purposeCategory`	List	Full path of purpose categories — the last item is the assigned category
`purposeCategoryId`	String	Unique ID for the purpose category (corresponds to the last item in `purposeCategory`)

Business and purpose category lists are available on request — contact bank-account-data-sales@gocardless.com.

What's next?#

Quickstart Guide

Follow the step-by-step guide to connect your first bank account and retrieve enriched transaction data.

Learn more

Transactions

Understand the full transaction response structure and how enrichment fields map to raw data.

Learn more