Retrieve a transaction

GET

https://api.ntropy.com/v3/transactions/:id

GET

/v3/transactions/:id

$ curl -X "GET" \
>     "https://api.ntropy.com/v3/transactions/xbx8YP14g565Xk" \
>     -H "Accept: application/json" \
>     -H "X-API-KEY: cd1H...Wmhl"

1 {
2   "id": "xbx8YP14g565Xk",
3   "description": "SQ* STARBUCKS 10 Union Sq",
4   "date": "2024-03-30",
5   "amount": 10,
6   "entry_type": "outgoing",
7   "currency": "USD",
8   "created_at": "2024-03-30T00:00:00",
9   "entities": {
10     "counterparty": {
11       "type": "organization",
12       "id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
13       "name": "Starbucks",
14       "website": "starbucks.com",
15       "phone_number": "+1 4153753176",
16       "tax_number": "80-0429876",
17       "naics2017": "541519",
18       "logo": "https://logos.ntropy.com/starbucks.com",
19       "mccs": [
20         5814
21       ]
22     },
23     "intermediaries": [
24       {
25         "id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
26         "name": "Square, Inc.",
27         "website": "squareup.com",
28         "logo": "https://logos.ntropy.com/squareup.com",
29         "mccs": []
30       }
31     ]
32   },
33   "categories": {
34     "general": "coffee shop"
35   },
36   "location": {
37     "raw_address": "10 Union Square E, New York, New York 10003, United States",
38     "structured": {
39       "street": "Union Square East",
40       "city": "New York",
41       "state": "New York",
42       "postcode": "10003",
43       "country_code": "US",
44       "country": "United States",
45       "house_number": "10",
46       "latitude": 40.734834,
47       "longitude": -73.989782,
48       "google_maps_url": "https://www.google.com/maps/search/?api=1&query=40.734834,-73.989782",
49       "apple_maps_url": "https://maps.apple.com/?q=40.734834,-73.989782"
50     }
51   },
52   "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad"
53 }

curl -X "GET" \
    "https://api.ntropy.com/v3/transactions/xbx8YP14g565Xk" \
    -H "Accept: application/json" \
    -H "X-API-KEY: cd1H...Wmhl"  

{
  "id": "xbx8YP14g565Xk",
  "description": "SQ* STARBUCKS 10 Union Sq",
  "date": "2024-03-30",
  "amount": 10,
  "entry_type": "outgoing",
  "currency": "USD",
  "created_at": "2024-03-30T00:00:00",
  "entities": {
    "counterparty": {
      "type": "organization",
      "id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
      "name": "Starbucks",
      "website": "starbucks.com",
      "phone_number": "+1 4153753176",
      "tax_number": "80-0429876",
      "naics2017": "541519",
      "logo": "https://logos.ntropy.com/starbucks.com",
      "mccs": [
        5814
      ]
    },
    "intermediaries": [
      {
        "id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
        "name": "Square, Inc.",
        "website": "squareup.com",
        "logo": "https://logos.ntropy.com/squareup.com",
        "mccs": []
      }
    ]
  },
  "categories": {
    "general": "coffee shop"
  },
  "location": {
    "raw_address": "10 Union Square E, New York, New York 10003, United States",
    "structured": {
      "street": "Union Square East",
      "city": "New York",
      "state": "New York",
      "postcode": "10003",
      "country_code": "US",
      "country": "United States",
      "house_number": "10",
      "latitude": 40.734834,
      "longitude": -73.989782,
      "google_maps_url": "https://www.google.com/maps/search/?api=1&query=40.734834,-73.989782",
      "apple_maps_url": "https://maps.apple.com/?q=40.734834,-73.989782"
    }
  },
  "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad"
}

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

Successful Response

idstring>=1 character

A unique identifier of the transaction

descriptionstring0-1024 characters

The description string of the transaction

datedate

The date that the transaction was posted. Uses ISO 8601 format (YYYY-MM-DD)

amountdouble>=0

The amount of the transaction in the currency. Must be a positive value. For example, if the currency is USD, then it’s the amount in dollars.

entry_typeenum

The direction of the flow of the money from the perspective of the account holder. outgoing to represent money leaving the account, such as purchases or fees, while incoming represents money entering the account, such as income or refunds.

Allowed values:

currencyenum

The currency of the transaction in ISO 4217 format

created_atdatetime

The timestamp of when the account holder was created.

entitiesobject or null

Entities found by identity identification

categoriesobject or null

locationobject or null

errorobject or null

account_holder_idstring or null1-256 characters

The unique ID of the account holder of the transaction

Errors

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X "GET" \
>	"https://api.ntropy.com/v3/transactions/xbx8YP14g565Xk" \
>	-H "Accept: application/json" \
>	-H "X-API-KEY: cd1H...Wmhl"

1	{
2	"id": "xbx8YP14g565Xk",
3	"description": "SQ* STARBUCKS 10 Union Sq",
4	"date": "2024-03-30",
5	"amount": 10,
6	"entry_type": "outgoing",
7	"currency": "USD",
8	"created_at": "2024-03-30T00:00:00",
9	"entities": {
10	"counterparty": {
11	"type": "organization",
12	"id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
13	"name": "Starbucks",
14	"website": "starbucks.com",
15	"phone_number": "+1 4153753176",
16	"tax_number": "80-0429876",
17	"naics2017": "541519",
18	"logo": "https://logos.ntropy.com/starbucks.com",
19	"mccs": [
20	5814
21	]
22	},
23	"intermediaries": [
24	{
25	"id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
26	"name": "Square, Inc.",
27	"website": "squareup.com",
28	"logo": "https://logos.ntropy.com/squareup.com",
29	"mccs": []
30	}
31	]
32	},
33	"categories": {
34	"general": "coffee shop"
35	},
36	"location": {
37	"raw_address": "10 Union Square E, New York, New York 10003, United States",
38	"structured": {
39	"street": "Union Square East",
40	"city": "New York",
41	"state": "New York",
42	"postcode": "10003",
43	"country_code": "US",
44	"country": "United States",
45	"house_number": "10",
46	"latitude": 40.734834,
47	"longitude": -73.989782,
48	"google_maps_url": "https://www.google.com/maps/search/?api=1&query=40.734834,-73.989782",
49	"apple_maps_url": "https://maps.apple.com/?q=40.734834,-73.989782"
50	}
51	},
52	"account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad"
53	}