Enrich Transaction

get https://pfm.genify.ai/api/v1.0/txn-data/

This endpoint categorizes a banking transaction from its description and amount, and also returns the corresponding merchant website, logo and carbon footprint. Any one, two or all three features can be queried. Make sure to contact Genify to receive your authorization key.

Query Params

description

string

required

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

string

required

Value of the transaction in USD. Note that -ve amounts = expenses and +ve amounts = income; which affects categorization results.

date

string

required

Date at which transaction occurred in the format : YYYY-MM-DD

country

string

required

Country where the transaction was preformed. Need to insert the right format otherwise it will lead to an error, e.g., Egypt, EG or EGY. (you can find the country taxonomy in the getting started guide)

currency

string

Defaults to USD

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"]

mcc

int32

Merchant category code (Use model_name = model_4 to use the mcc mapper as the primary categorizer)

bank_code

string

Code of that client that will be used to fetch static categorization for the requested transaction.

Headers

username

string

required

Your username.

account_id

string

required

Can be filled by 0 during your testing. - - - In production, you should send an end-user pseudo-ID (1 person using your app ⇒ 1 unique pseudo-ID)

model_name

string

Defaults to model_5

Name of the categorizer model to use. Defaults to model_5.

200200

400400

500500