API Reference

Enrich transactions

post
https://api.moneyhub.co.uk/caas/v1/transactions/enrich

Requires the caas:transactions:write scope. Upload transactions to be enriched by Moneyhub's Data Enrichment Engine

Body Params
string | null

Unique identifier for the customer/user.

string
required
length between 8 and 36

Unique identifier for the account.

string
required
length between 8 and 36

Unique identifier for the transaction.

string
enum
required

The account type. Permitted values as follows: 'cash' - current accounts; 'card' - credit cards; 'savings' - savings accounts; 'investment' - investment accounts; 'loan' - loan accounts; 'mortgage' - mortgage accounts; 'pension' - pension accounts

Allowed:
string | null

The transaction code. Permitted values as follows: 'DEB' - general debit card transaction; 'CR' - general bank credit; 'TFR' - general transfer to/from; ')))' - contactless purchase; 'DD' - direct debit; 'SO' - standing order; 'BGC' - bank giro credit; 'ATM' - cash withdrawal; 'CHQ' - cheque; 'CHG' - bank charge. For credit card transactions or if unsure for a transaction set to the empty string. Although we do accept more codes; please supply us a list of the transaction codes you'd like to use and we'll either let you know if they are supported or how you can map onto our transaction codes.

date-time
required
length ≤ 35

The date and time of the transaction in ISO 8601 format.

string
enum
required

The status of the transaction: e.g. pending, posted (booked)

Allowed:
string
required
length ≤ 256

The transaction description which is commonly a combination of the merchant name and merchant location.

number
required

The transaction amount in major units of the currency.

string
length ≤ 3
Defaults to GBP

The currency of the transaction e.g. GBP, EUR. Defaults to GBP

string | null

MCC code for the merchant's primary activities. A maximum 4 digit string which we will left pad with 0s to make 4 digits if necessary.

boolean | null

Indicates if the cardholder was present when the transaction occurred. Note that, online purchases are considered card holder not present. Only card holder present transactions are eligible for geotagging. Commonly derived from the POS entry mode: e.g. '07' is contactless chip read so card present. Do not specify or set to true if unknown/unsure; the engine uses this field as part of the estimation of a more accurate card present flag.

meta
object | null

Optional object containing additional data about the transaction. This can be used to store additional information about the transaction.

splits
array of objects
length ≥ 2

The transaction splits. Only present when the client holds the caas:transaction_splits:read scope and the transaction has been split. Requires a minimum of 2 splits; the sum of split amounts must equal the parent transaction amount.

splits
Responses

Updated 17 days ago

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

Updated 17 days ago