Ntropy Transaction API v1

Ntropy Transaction API for transaction classification & management

Contact Support: Name: API Support Email: api@ntropy.network

AUTHORIZATIONAPI Key

Key

X-API-KEY

Value

classifier

AUTHORIZATIONAPI Key

This folder is using API Key from collectionNtropy Transaction API v1

consumer

AUTHORIZATIONAPI Key

This folder is using API Key from collectionNtropy Transaction API v1

batch

AUTHORIZATIONAPI Key

This folder is using API Key from collectionNtropy Transaction API v1

POSTClassify a batch of transactions.

https://api.ntropy.network/classifier/consumer/batch

Classify a batch of consumer transactions. Uploaded file should contain a JSON structure: { transactions: [ <ConsumerTransaction> ] }, where ConsumerTransaction adheres to ConsumerTransaction object schema.

AUTHORIZATIONAPI Key

This request is using API Key from collectionNtropy Transaction API v1

HEADERS

Content-Type

application/json

Bodyraw

[
    {
        "transaction": {
            "transaction_id": "xbx8YP14g565Xketw3tFmn4yp49x3tbj9mD8DB4fM8DDY6x",
            "possible_labels": ["Food and drink", "Service", "Shops", "Fashion", "Travel", "Software", "Healthcare", "Loan", "Fitness", "Beauty", "Insurance", "Washing", "Gas", "Groceries", "Restaurants", "Liquor", "Bank", "Broker", "Subscription", "Income", "Transfer", "Payment", "Fees", "Refund", "ATM", "Salary", "Deposit", "Investment", "Bill", "Car maintenance", "Tax", "Charity", "Withdrawal"],
            "amount": 41.86,
            "entry_type": "outgoing",
            "date": "2019-12-01",
            "iso_currency_code": "USD",
            "description": "TARGET T- 5800 20th St 11/30/19 17:32",
            "payment_channel": "in store",
            "pending": false,
            "moto_eci_code": "1",
            "pan_entry_mode_auth": "90",
            "pan_entry_mode_capture": "B"
        },
        "user": {
            "user_id": "12345-user",
            "zip_first_3_digits": "123",
            "email_domain": "gmail.com"
        },
        "device": {
            "os": "Android",
            "ipv4": "127.0.0.1",
            "lat": 40.6809399,
            "lon": 74.043323
        }
    }
]

Example Request

curl

curl --location 'https://api.ntropy.network/classifier/consumer/batch' \
--header 'X-API-KEY: <API Key>' \
--data '[
    {
        "transaction": {
            "transaction_id": "xbx8YP14g565Xketw3tFmn4yp49x3tbj9mD8DB4fM8DDY6x",
            "possible_labels": ["Food and drink", "Service", "Shops", "Fashion", "Travel", "Software", "Healthcare", "Loan", "Fitness", "Beauty", "Insurance", "Washing", "Gas", "Groceries", "Restaurants", "Liquor", "Bank", "Broker", "Subscription", "Income", "Transfer", "Payment", "Fees", "Refund", "ATM", "Salary", "Deposit", "Investment", "Bill", "Car maintenance", "Tax", "Charity", "Withdrawal"],
            "amount": 41.86,
            "entry_type": "outgoing",
            "date": "2019-12-01",
            "iso_currency_code": "USD",
            "description": "TARGET T- 5800 20th St 11/30/19 17:32",
            "payment_channel": "in store",
            "pending": false,
            "moto_eci_code": "1",
            "pan_entry_mode_auth": "90",
            "pan_entry_mode_capture": "B"
        },
        "user": {
            "user_id": "12345-user",
            "zip_first_3_digits": "123",
            "email_domain": "gmail.com"
        },
        "device": {
            "os": "Android",
            "ipv4": "127.0.0.1",
            "lat": 40.6809399,
            "lon": 74.043323
        }
    }
]'

202 Accepted

Example Response

json

{
  "status": "error",
  "updated_at": "2003-03-26T14:21:33.187Z",
  "id": "urn:uuid:d5ada2ee-a44f-11f3-0a66-907",
  "progress": 37466407,
  "results": [
    {
      "transaction_id": "eiusmod",
      "labels": [
        "mollit",
        "deserunt enim nostrud laborum"
      ],
      "rating": {
        "value": 75741470.92226714,
        "reviews": 58349812
      },
      "contact": {
        "phone": "cupidatat id",
        "email": "GhBcUtjWLEB@CfemFOINBWYwIiqBvOYRJVjrcvKHrvxX.de"
      },
      "location": {
        "lat": 57317087.81368473,
        "lon": 94113460.95897937,
        "address": "elit deserunt",
        "city": "ex veniam fugiat Lorem consectetur",
        "postal_code": "dolore ullamco tempor culpa",
        "country": "dolore voluptate velit nisi"
      },
      "logo": "non veniam",
      "website": "voluptate adipisicing amet exercitation",
      "merchant": "deserunt in",
      "person": "culpa reprehe"
    },
    {
      "transaction_id": "enim consequat nulla proident",
      "labels": [
        "Ut ex cillum ad",
        "deserunt sint proident"
      ],
      "rating": {
        "value": -93588061.43173082,
        "reviews": -48614693
      },
      "contact": {
        "phone": "nulla Excepteur cupidatat ea",
        "email": "6T5Rg@bRGMnAcYjPQjVUi.qvv"
      },
      "location": {
        "lat": 88584659.67396057,
        "lon": 70216151.33024582,
        "address": "qui aute reprehenderit",
        "city": "id adipisicing commodo",
        "postal_code": "est",
        "country": "reprehenderit"
      },
      "logo": "sunt quis amet dolor nulla",
      "website": "dolore aute velit",
      "merchant": "dolor cillum",
      "person": "dolore eu"
    }
  ]
}

Content-Type

application/json

GETGet a batch of consumer transaction classification results.

https://api.ntropy.network/classifier/consumer/batch/:id

Get a batch of consumer transaction classification results.

AUTHORIZATIONAPI Key

This request is using API Key from collectionNtropy Transaction API v1

PATH VARIABLES

247ee045-3d04-4b3c-872b-a9160b810f33

(Required) Batch id.

Example Request

curl

curl --location 'https://api.ntropy.network/classifier/consumer/batch/:id' \
--header 'X-API-KEY: <API Key>'

404 Not Found

Example Response

No response body

This request doesn't return any response body

Content-Type

text/plain