Batch Retrieval Demo
Batch Retrieval Demo Video
200
400
401
404
403
500
Query Parameters
Name
Type
Description
country*
string
Country where transaction was preformed. Need to insert the right
otherwise it will lead to an error, e.g., Egypt, EG or EGY.
date*
string
Date at which transaction occurred in the format: YYYY-MM-DD
format
latitude
number
Latitude of transaction merchant
(mandatory if longitude is provided.)
longitude
number
Longitude of transaction merchant
(mandatory if latitude is provided.)
amount*
string
Value of the transaction in USD by default. Negative ➖ amounts
are expenses, positive ➕ amounts are incoming transactions.
description*
string
Description of the transaction, e.g.,
"Cafe Lucia Plaza Central XY123"
(Note: if the char "&" is part of passed
description in IDE, please use "%26" instead.)
mcc
number
Merchant category code (Use model_name = model_4
to use the mcc mapper as the primary categorizer)
currency
string
Options: [ Default:"USD", "EUR", "GBP", "AED", "SAR",
"EGP", "AUD", "BRL", "CAD", "CHF", "CNY", "COP", "DKK",
"HKD", "HUF", "INR", "JPY", "MXN", "MYR", "NOK",
"OMR", "PHP", "PLN", "RON", "SEK", "SGD", "UAH", "ZAR"]
Get Categorized Transaction
https://pfm.genify.ai/api/v1.0/txn-data/
The unified endpoint can be used to only categorize a banking transaction (from a credit card, a debit card or a bank account) from its description and amount. The transaction is categorized as one of ~80 categories in Genify's category tree.
Enrich Transaction Data
https://pfm.genify.ai/api/v1.0/txn-data/
Unified endpoint: this single endpoint can be used for all three features (categorization, merchant logo, carbon footprint), for convenience. This endpoint categorizes a banking transaction from its description and amount, and also returns the corresponding merchant logo and carbon footprint. Any one, two or all three features can be queried (See individual endpoint documentation for more details).
Headers
Name
Type
Description
Account_id*
String
id used to identify current user provided in format of
account_
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
Category*
String
Flag used to activate categorizer.
Model_name
String
Name of the machine learning model to
use. COMING SOON: separate endpoint to
retrieve the list available. Defaults to model_2.
Username*
String
Your username
Authorization*
String
API key associated with your Genify account.
Website
Boolean
flag specifies weither to get merchant website or not.
value: 0(default) or 1.
Enrich Transaction Data
Get Categorized Transaction
Get Categorized Transaction (based on client code)
Get Merchant Logo
Get Carbon Footprint
Post Classification Error
Batch Transactions
Batch Transactions Demo
Retrieve Batch Transactions
Batch Retrieval Demo
Was this helpful?
Query Parameters
Name
Type
Description
bank_code*
String
code of that client that will be used to fetch static categorization for the requested transaction.
country*
string
Country where transaction was preformed. Need to insert the right
format
otherwise it will lead to an error, e.g., Egypt, EG or EGY.
Headers
Name
Type
Description
Username*
String
Client name.
Authorization*
String
Client api_key.
Category*
Boolean
Flag used to activate categorizer.
Account_id*
String
id used to identify current user provided in format of
account_ eg: account_0 which exists for testing.
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
Query Parameters
Name
Type
Description
longitude
number
Longitude of transaction merchant
(mandatory if latitude is provided.)
latitude
number
Latitude of transaction merchant
(mandatory if longitude is provided.)
date*
string
Date at which transaction occurred in the format: YYYY-MM-DD
country*
string
Country where transaction was preformed. Need to insert the right
format
otherwise it will lead to an error, e.g., Egypt, EG or EGY.
description*
string
Description of the transaction, e.g.,
"Cafe Lucia Plaza Central XY123"
amount*
Number
Value of the transaction in USD by default. Negative ➖ amounts
are expenses, positive ➕ amounts are incoming transactions.
200 categorization successful
400 mis…
401 invalid us…
500
Transaction Data API
Endpoints used to enrich banking transaction data with categories, merchant logos and the carbon footprint.
The Transaction Data API endpoints require authorization (via API key) as they are hosted by Genify in the cloud. Other endpoints are installed on our clients' cloud or premises.
Last updated 7 months ago
200
400
401
404
403
500
200
400 missing ...
401 no author…
500
200: OK success
400 bad req...
401 unauthor…
403: forbidd..
200 success
400 mis…
401 invalid us…
404 no ser …
500 error …
403 user is…
Headers
Name
Type
Description
account_id*
string
id used to identify current user provided in format of
account_ eg: account_0 which exists for testing.
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
category_name
string
If carbon_footprint is true, the category_name
can be inserted to avoid running the categorizer
and use the category you provide instead.
category_id
string
If carbon_footprint is true, the category_id can be inserted to avoid
running the categorizer and use the category you provide instead
model_name
string
Name of the machine learning model to
use. COMING SOON: separate endpoint to
retrieve the list available. Defaults to model_2.
logo
boolean
If false or omitted, no logo is returned.
carbonfootprint
boolean
If false or omitted, omits carbon footprint value from response.
category
boolean
If false or omitted, omits category
name and id values from response.
username*
string
Your username
authorization*
string
API key associated with your Genify account.
logo_format
String
Logo format you want returned.
Options: [Default: raw, round, square]
website
boolean
flag specifies weither to get merchant website or not.
value: 0(default) or 1.
Get Categorized Transaction (based on client code)
https://pfm.genify.ai/api/v1.0/txn-data/
200: OK success message
400 bad request ...
200
400
401
404
403
500
Get Merchant Logo
https://pfm.genify.ai/api/v1.0/txn-data/
The same endpoint can be used to only obtain the merchant logo corresponding to a transaction. The merchant logo is retrieved from Genify's proprietary database which grows incrementally if an unknown merchant is queried.
Headers
Name
Type
Description
Account_id*
String
id used to identify current user provided in format of
account_ eg: account_0 which exists for testing.
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
Model_name
String
Name of the machine learning model to
use. COMING SOON: separate endpoint to
retrieve the list available. Defaults to model_2.
Logo*
String
Flag used to activate logo grabber.
Authorization*
String
API key associated with your Genify account.
Username*
String
Your username
Logo_format
String
Format of the output logo. Options: raw, square or round. Default: raw.
Website
Boolean
flag specifies weither to get merchant website or not.
value: 0(default) or 1.
Headers
Name
Type
Description
Username*
String
Your username
Authorization*
String
API key associated with your Genify account.
Headers
Name
Type
Description
Account_id*
String
id used to identify current user provided in format of
account_ eg: account_0 which exists for testing.
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
category_id
string
If carbon_footprint is on, user can insert a category ID to avoid wait time of categorizer.
category_name
string
If carbon_footprint is on, user can insert a category name to avoid wait time of categorizer.
Carbon footprint*
Boolean
Flag used to activate carbon footprint calculation.
Username*
String
Your username
Authorization*
String
API key associated with your Genify account.
Request body
Name
Type
Description
Description*
string
The endpoint on which the user wants to report an error.
wrong_category*
string
Genify's categorization to client's request.
suggested_category*
string
the endpoint on which the user wants to report an error.
Query Parameters
Name
Type
Description
account_id*
string
id used to identify current user provided in format of
account_ eg: account_0 which exists for testing.
(Note: the more the data collected for your user's
id, the better results the models will provide you.)
This account_id will be overwritten in case of providing a specific account_id with each txn.
category_name
string
If carbon_footprint is true, the category_name
can be inserted to avoid running the categorizer
and use the category you provide instead.
category_id
string
If carbon_footprint is true, the category_id can be inserted to avoid
running the categorizer and use the category you provide instead
model_name
string
Name of the machine learning model to
use. COMING SOON: separate endpoint to
retrieve the list available. Defaults to model_2.
logo
boolean
If false or omitted, omits logo from response. [removed value]
Carbon footprint*
Boolean
If false or omitted, omits carbon footprint value from response.
Category*
Boolean
If false or omitted, omits category name and id values from response.
date*
string
Date at which transaction occurred in the format: YYYY-MM-DD
Username*
String
Your username
Authorization*
String
API key associated with your Genify account.
Logo_format
String
Format of the output logo. Options: raw, square or round. Default: raw.
Enable_caching
Boolean
Flag that specifies whether to cache a merchant or not, in case It was not already cached. default: 0. value: 0 or 1.
Extend_db
Boolean
Flag that specifies whether to store a merchant in the database or not. default: 0. value: 0 or 1
Website
Boolean
flag specifies weither to get merchant website or not.
value: 0(default) or 1.
Query Parameters
Name
Type
Description
longitude
number
Longitude of transaction merchant
(mandatory if latitude is provided.)
latitude
number
Latitude of transaction merchant
(mandatory if longitude is provided.)
date*
string
Date at which transaction occurred in the format: YYYY-MM-DD
country*
string
Country where transaction was preformed. Need to insert the right
format
otherwise it will lead to an error, e.g., Egypt, EG or EGY.
amount*
Number
Value of the transaction in USD by default. Negative ➖ amounts
are expenses, positive ➕ amounts are incoming transactions.
description*
string
Description of the transaction, e.g.,
"Cafe Lucia Plaza Central XY123"
(Note: if the char "&" is part of passed
description in IDE, please use "%26" instead.)
Currency
string
Options: [ Default:"USD", "EUR", "GBP", "AED", "SAR", "EGP", "AUD", "BRL", "CAD", "CHF", "CNY", "COP", "DKK", "HKD", "HUF", "INR", "JPY", "MXN", "MYR", "NOK", "OMR", "PHP", "PLN", "RON", "SEK", "SGD", "UAH", "ZAR"]
200 success
400 missing des...
401 authorization is..
Query Parameters
Name
Type
Description
longitude
number
Longitude of transaction merchant
(mandatory if latitude is provided.)
latitude
number
Latitude of transaction merchant
(mandatory if longitude is provided.)
date*
string
Date at which transaction occurred in the format: YYYY-MM-DD
country*
string
Country where transaction was preformed. Need to insert the right
format
otherwise it will lead to an error, e.g., Egypt, EG or EGY.
description*
string
Description of the transaction, e.g.,
"Cafe Lucia Plaza Central XY123"
(Note: if the char "&" is part of passed
description in IDE, please use "%26" instead.)
amount*
Number
Value of the transaction in USD by default. Negative ➖ amounts
are expenses, positive ➕ amounts are incoming transactions.
Sample CSV
CSV File input
Batch Transactions Demo
Demo Video with JSON body input
Batch Transactions
https://pfm.genify.ai/api/v1.0/txn-data/
This Endpoint will automatically operate as a batch endpoint whenever it gets a input as "raw body", "csv file", or "json file". The input ideally should contain list of transactions to be processed in batches.
Get Carbon Footprint
https://pfm.genify.ai/api/v1.0/txn-data/
The same endpoint can be used to only calculate the carbon footprint (carbon-equivalent weight in kg) corresponding to a transaction description, amount and category ID/name. The carbon footprint is computed using Genify's curated database of carbon footprint values. When no category is passed as input, the Genify transaction categorizer is used to infer the category.
Request Body
Name
Type
Description
txns_uuids
List
A list containing the txns uuid/s of transactions that we want to retrieve
Retrieve Batch Transactions
https://pfm.genify.ai/api/v1.0/txn-data/retrieve-txn/batch/
In this Endpoint we will make use of the Txns UUIDs generated to retrieve all the Txns or Retrieve any number of txns by specifying their UUIDs
Request body
Name
Type
Description
txns
JSON file
The endpoint on which the user wants to report an error.
txns
csv file
The second way of using batch endpoint, in CSV format, by attaching a CSV file as "Form-Data",
txns
List
This is the first scenario of inputting transactions. We add in the raw body option (JSON Formatted), a list containing transactions in form of a JSON object each Transaction Parameters Required are: { "description", "amount", "country"} Optional: {"mcc", "bank-code", "account-id"}