v1

latestOpenAPI 3.1.02026-07-13385987.3 KB

Account Holder

Correct any transaction property.

Provide a correction for any field of a previously enriched transaction.

put/v2/account-holder/{account_holder_id}/transactions/{transaction_id}

Path parameters

transaction_idstring required

account_holder_idstring required

Request body

logostring nullable

websitestring nullable

locationstring nullable

{"stackTrail":"components:schemas:EnrichedTransactionCorrection:properties:location_structured:anyOf","oasType":"schema","type":"unknown","title":"Location Structured","nullable":true}

merchantstring nullable

labelsstring[] nullable

{"stackTrail":"components:schemas:EnrichedTransactionCorrection:properties:recurrence:anyOf","oasType":"schema","type":"unknown","title":"Recurrence","nullable":true}

personstring nullable

{"stackTrail":"components:schemas:EnrichedTransactionCorrection:properties:transaction_type:anyOf","oasType":"schema","type":"unknown","title":"Transaction Type","nullable":true}

review_state'incomplete' | 'satisfied' | 'forced'

Response

Enriched transaction with the corrected fields

transaction_idstring required

logostring nullable

websitestring nullable

locationstring nullable

merchantstring nullable

merchant_idstring nullable

labelsstring[] nullable

recurrence'recurring' | 'subscription' | 'one off'

recurrence_group_idstring nullable

personstring nullable

transaction_type'business' | 'consumer' | 'unknown'

mccinteger[] nullable

Example response

{
  "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"
}