v1

latestOpenAPI 3.1.02026-07-13385987.3 KB

Account Holder

Get transactions of an account holder by transaction id.

Fetch all the transactions matching given transaction ids in the transaction ledger of an account holder. Transactions returned will be in arbitrary order.

post/v2/account-holder/{account_holder_id}/transactions

Path parameters

account_holder_idstring required

Query parameters

pageinteger

Page number

per_pageinteger

How many items per page

sort_bystring nullable

Column to sort items by, allowed values are ['date']. When not specified the default order will be used.

sort_order'asc' | 'desc'

Sorting direction asc or desc

Request body

string[] required

Response

List of transactions for the account holder.

pagesinteger nullable

Example response

{
  "transactions": [
    {
      "intermediaries": [
        {
          "id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
          "logo": "https://logos.ntropy.com/squareup.com",
          "name": "Square",
          "website": "squareup.com"
        }
      ],
      "labels": [
        "Cafes and coffee shop"
      ],
      "location": "10 Union Square East, New York, New York 10003, US",
      "location_structured": {
        "address": "10 Union Square East",
        "apple_maps_url": "https://maps.apple.com/?q=Starbucks+10+Union+Square+East&sll=40.734834,-73.989782",
        "city": "New York",
        "country": "US",
        "country_name": "United States",
        "google_maps_url": "https://www.google.com/maps/search/?api=1&query=Starbucks%2C10+Union+Square+East%2C+New+York%2C+New+York+10003%2C+US",
        "latitude": "48.734834",
        "longitude": "-73.989782",
        "postcode": "10003",
        "state": "New York"
      },
      "logo": "https://logo.clearbit.com/aws.amazon.com",
      "merchant": "Starbucks",
      "merchant_id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
      "recurrence": "recurring",
      "recurrence_group": {
        "average_amount": 10,
        "first_payment_date": "2020-02-02",
        "id": "3b0c689b-e123-30a6-9f53-878f3ebf46aa",
        "latest_payment_date": "2022-02-02",
        "other_party": "starbucks.com",
        "periodicity": "monthly",
        "periodicity_in_days": 31,
        "total_amount": 240,
        "transaction_ids": [
          "b708fbd8-be76-41c2-86d5-83f8ba05ed85",
          "0e34b24d-646d-416e-8d51-fda5b6e10684"
        ]
      },
      "recurrence_group_id": "3b0c689b-e123-30a6-9f53-878f3ebf46aa",
      "transaction_id": "xbx8YP14g565Xk",
      "website": "starbucks.com"
    }
  ]
}