Skip to main content

Enrichment API

The Enrichment V2 endpoint accepts a response-type parameter, which should be set to consumer. It returns enriched customer transactions.


Authorization

HeaderValue
Api-keystring (tkn_ten_XXX..)
Content-Typeapplication/json

Enriching Transactions

Endpoint

POST https://enrichment-prd-uae.lunedata.io/api/v2/transaction/enrich?response-type=consumer

Query Parameters

KeyValue
response-typeconsumer

Request Body Schema

Required (Required field) · Important (Impacts accuracy/functionality — essentially required if available)

FieldTypeLunehub
Transactions
Analytics
(Insights & Nudges)
Lune Pulse
Core Transaction Fields
raw_descriptionstringRequiredRequiredRequired
amountfloatRequiredRequiredRequired
ref_idstringRequiredRequiredRequired
transaction_idstringRequiredRequiredRequired
Identity Fields
customer_idstringRequiredRequiredRequired
account_idstringImportantRequiredRequired
card_idstringImportantRequiredRequired
card_namestringImportantRequiredRequired
Merchant Fields
merchant_namestringRequiredRequiredRequired
merchant_idstringImportantImportantRequired
mccstringRequiredRequiredRequired
Transaction Metadata
directionstringRequiredRequiredRequired
is_self_transactionbooleanRequiredRequiredRequired
is_transferbooleanRequiredRequiredRequired
iso_currency_cdstringRequiredRequiredRequired
occurred_atstring/DateTimeRequiredRequiredRequired
pos_idstringImportantImportantRequired
pos_entry_modestringImportantImportantRequired
Location object
sub-fields of location object
locationobjectRequiredRequiredRequired
iso_country_cdstringRequiredRequiredRequired
citystringRequiredRequiredRequired
addressstringImportantImportantImportant
regionstringImportantImportantImportant
postal_codestringImportantImportantImportant

Response Schema

FieldTypeDescription
ref_idstringReference ID for the enriched transaction
transaction_idstringClient's internal transaction ID (returned in place of ref_id only when the client's account is configured to return transaction_id)
global_tx_idstringUnique global transaction identifier
brand_namestringEnriched brand name
brand_name_arstringBrand name transliterated or translated in Arabic (returned only if Arabic is enabled for the tenant)
brand_logostringRelative path to brand logo. Concatenate with https://brandlogos.azureedge.net/media/
brand_urlstringWebsite URL of the brand
category_idstringConsumer category identifier
category_namestringConsumer category name in English
category_name_arstringConsumer category name in Arabic (returned only if Arabic is enabled for the tenant)
sub_category_idstringConsumer sub-category identifier
sub_category_namestringConsumer sub-category name in English
sub_category_name_arstringConsumer sub-category name in Arabic (returned only if Arabic is enabled for the tenant)
Request Example
{
"transactions": [
{
"raw_description": "STARBUCKS-D582 AL SHAY DUBAI ARE",
"amount": -40,
"ref_id": "0001234",
"transaction_id": "1234AB34",
"customer_id": "cust1",
"account_id": "acc1",
"card_id": "card1",
"card_name": "Emirates Skywards Platinum",
"merchant_name": "STARBUCKS-D582 AL SHAY DUBAI ARE",
"direction": "DEBIT",
"is_self_transaction": false,
"is_transfer": true,
"iso_currency_cd": "AED",
"occurred_at": "2025-09-30",
"mcc": "0780",
"merchant_id": "43253545",
"pos_id": "POS12345",
"pos_entry_mode": "CHIP",
"location": {
"iso_country_cd": "ARE",
"city": "Dubai",
"address": "Al Suwayeb Str. 28",
"region": null,
"postal_code": null
}
}
]
}
Response Example
{
"transactions": [
{
"brand_name": "Starbucks",
"brand_logo": "brand_logos/Starbucks_RsMC6xy.png",
"global_tx_id": "1a4aa7df-1c31-43ec-99a1-9604419caf44",
"brand_name_ar": "ستاربكس",
"brand_url": "https://www.starbucks.com/",
"category_id": "10",
"category_name": "Dining",
"sub_category_id": "10-3",
"sub_category_name": "Coffeeshop",
"category_name_ar": "المطاعم",
"sub_category_name_ar": "مقهى",
"ref_id": "1a4aa7df-1c31-43ec-99a1-9604419caf44"
}
]
}
note

If the client’s account is configured to enforce the transaction_id field, only then will the transaction_id be included in the response.


Response Status Codes

  • 200 Success: Standard response for successful HTTP requests.
  • 400 Bad Request: The request cannot be fulfilled due to bad syntax.