Enrich Transaction

Query Params
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.)

string
required

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

date
required

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

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)

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

integer

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

string

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

Headers
string
required

Your username.

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)

string
Defaults to model_5

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

integer
Defaults to 0

If 0 or omitted, omits category name and id values from response.

integer
Defaults to 0

Flag specifies whether to get merchant website or not. value: 0(default) or 1.

If 0 or omitted, no logo is returned.

string
Defaults to raw

Logo format you want returned. Options: [Default: raw, round, square]

integer
Defaults to 0

when enabled, it determines if the transaction is a recurring payment or not

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json