Enrich

get

https://au-api.basiq.io/enrich

The Enrich resource enables you to retrieve details by passing in a search query containing a bank transaction description. The service enriches transaction data with multiple attributes, returning a transaction classification and three metadata components. The transaction classification will first determine if the transaction is of type payment, transfer, cash-withdrawal, bank-fee etc. The engine then derives merchant information, purchase location and prescribes an industry standard categorisation for each payment transaction.

Query Params

string

required

This is the search string that is used to lookup the entity (merchant) information. **q=garfish%20MANLY%20NS**&country=AU&institution=AU06703

institution

string

required

Identifies the institution from where the transaction was derived. This must be a Basiq recognisable institution ID. enrich?METRO%20PETROLEUM%20FR%20FORE&country=AU&accountType=transaction&amount=-12.95&**institution=AU04301**

country

string

required

Specifies the country the search should be narrowed down to. Passing in a country value will limit the search to the specified country. The country must be in ISO 3166 Alpha-2 format q=garfish%20MANLY%20NS&**country=AU**&institution=AU06703

mcc

string

Merchant classification code as defined by Visa and Mastercard q=garfish%20MANLY%20NS&country=AU&institution=AU06703&**mcc=3299**

accountType

string

The Account type from which the transaction was derived. METRO%20PETROLEUM%20FR%20FORE&country=AU&accountType=transaction&institution=AU04301 Valid values:

transaction - credit-card - savings - mortgage - loan - foreign

amount

string

The dollar/cent amount relevant to the transaction. q=garfish%20MANLY%20NS&country=AU&institution=AU06703&**amount=-12.95**

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Returns error that server cannot or will not process the request due to something that is perceived to be a client error.

403Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.

500Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.