Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ntropy transactions API

The transactions API from Ntropy — 3 operation(s) for transactions.

Ntropy transactions API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ntropy.com.

5 operations 3 paths 24 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ntropy transactions API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

transactions 5
POST
/v3/transactions
Synchronously enrich transactions
post-transaction-v-3-transactions-post 1 param body → 200422
GET
/v3/transactions
List all transactions
list-transactions-v-3-transactions-get 6 params → 200422
GET
/v3/transactions/{id}
Retrieve a transaction
get-transaction-v-3-transactions-id-get 2 params → 200404422
DELETE
/v3/transactions/{id}
Deletes a transaction
delete-transaction-v-3-transactions-id-delete 2 params → 204404422
POST
/v3/transactions/{id}/assign
Assign a transaction to an account holder
set-transaction-ah-v-3-transactions-id-assign-post 2 params body → 200404422

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are LocationStructured (12 properties), Transaction (12 properties), Counterparty (10 properties), Intermediary (9 properties). Each schema is shown below with its type and property counts.

TransactionError
object
2 properties 2 required
ValidationError
object
3 properties 3 required
Location
object
2 properties
LocationInput
object
Location of where the transaction has taken place. This can greatly improve entity identification, especially under ambiguity.
2 properties
TransactionInput
object
8 properties 6 required
CounterpartyType
string
PagedResponse_Transaction
object
2 properties 2 required
Country
string
Intermediary
object
9 properties
Entities
object
Entities found by identity identification
2 properties
EntityParent
object
6 properties
Counterparty
object
10 properties 1 required
EntryType
string
EnrichedTransaction
object
6 properties 2 required
Currency
string
Categories
object
2 properties 1 required
Transaction
object
12 properties 7 required
ValidationErrorLocItems
HTTPValidationError
object
1 property
Transactions_delete_transaction_v3_transactions__id__delete_Response_204
object
Empty response body
Body_set_transaction_ah_v3_transactions__id__assign_post
object
1 property 1 required
TransactionErrorCode
string
LocationStructured
object
12 properties
AccountingCategory
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-transactions-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API