Lune | API Documentation

Enrichment V1 (Deprecated)

The Enrichment endpoint returns the Brand Logo, Brand ID and Brand Name as well as the Category ID and Category Name for transactions. Transactions can be sent as single or bulk requests using the corresponding endpoints.

Enriching Transactions

Enriches single transaction

AUTHORIZATIONS:

Api-key

REQUEST BODY SCHEMA :

application/json

raw_description
required

string (Raw Description)

amount
required

float (Amount) >=1.0

Responses

RESPONSE SCHEMA :

application/json

brand_logo

string (Brand Logo URL)
The brand logo is concatenated with https://api.lunedata.io/media to get the actual image.

category_name

string (See All Categories)

brand_name

string (Brand Name)

category_id

string (See All Categories) [ 1 .. 255 ] charcters

brand_id

string (Brand ID is a unique identifier) [ 1 .. 255 ] charcters

POST

https://api.lunedata.io/api/v1/transaction/enrich/

Payload

application/json

Content type

{
  "raw_description": "string",
  "amount": 1
}

201

application/json

Content type

{
  "brand_logo": "string",
  "category_name": "string",
  "brand_name": "string",
  "category_id": "string",
  "brand_id": "string"
}

Enrich Bulk Transaction

Enriches the transactions in bulk

AUTHORIZATIONS:

Api-key

REQUEST BODY SCHEMA :

application/json

data >
required

Array of objects (Bulk Transaction Objects) [ items ]

Array [

local_id
‍required

string (Local ID is used to identify the transactions) [ 1 .. 36 ] charcters

raw_description
‍required

string (Raw Description)

amount
required

float (Amount) >=1.0

]

Responses

RESPONSE SCHEMA :

application/json

Array [

local_id

string (Local ID is used to identify the transactions) [ 1 .. 36 ] charcters

global_tx_id

string (Global transaction ID) [ 1 .. 36 ] charcters

category_id

string (See All Categories) [ 1 .. 255 ] charcters

cagtegory_name

string (See All Categories)

brand_id

string (Brand ID is a unique identifier) [ 1 .. 255 ] charcters

brand_name

string (Brand Name)

brand_logo

string (Brand Logo URL)
The brand logo is concatenated with https://api.lunedata.io/media to get the actual image.

]

POST

https://api.lunedata.io/api/v1/transaction/enrich/bulk/

Payload

application/json

Content type

{
  "data": [
    {
      "local_id": "string",
      "raw_description": "string",
      "amount": 1
    }
  ]
}

201

application/json

Content type

[
  {
    "local_id": "string",
    "global_tx_id": "string",
    "category_id": "string",
    "category_name": "string",
    "brand_id": "string",
    "brand_name": "string",
    "brand_logo": "string"
  }
]

Enrichment V2.1.2

The Enrichment V2 endpoint, Accepts a query parameter response-type that allows you to control response type from either consumer or business. It also returns the Brand Website URL, Business Category and Business Sub-category for transactions. Transactions can be sent as single or bulk requests using the same endpoint. Note that in case of not specifying response-type the consumer param value will be set by default.

Query Params (Key)

Value

response-type

consumer

Enriching Consumer Transactions

Enriches single or bulk transactions

AUTHORIZATIONS:

Api-key

REQUEST BODY SCHEMA :

application/json

transactions >
required

Array of objects (Bulk Transaction Objects) [ items ]

Array [

transaction_date

string (YYYY-MM-DD)

amount
‍required

float (Amount)

currency_code

string (Currency code) 3 charcters ISO currency code

raw_description
‍required

string (Raw Description)

ref_id

string (Reference ID)

]

Responses

RESPONSE SCHEMA :

application/json

transactions >

Array of objects (Bulk Transaction Objects) [ items ]

Array [

ref_id

string (Reference ID)

category_id

string (See All Main Consumer Categories) [ 1 .. 255 ] charcters

category_name

string (See All Main Consumer Categories)

sub_category_id

string (See All Consumer Sub-Categories) [ 1 .. 255 ] charcters

sub_category_name

string (See All Consumer Sub-Categories)

brand_id

string (Brand ID is a unique identifier) [ 1 .. 255 ] charcters

brand_name

string (Brand Name)

brand_logo

The brand logo is concatenated with https://api.lunedata.io/media to get the actual image.

brand_url

string (Brand website URL)

global_tx_id

string (Global Transaction ID)

]

POST

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

Payload

application/json

Content type

{
    "transactions" : [
         {
            "transaction_date" : "2022-12-25" ,
            "amount": -23.0,
            "currency_code": "AED",
            "raw_description": "Mcdonalds",
            "ref_id": "r1"
         },
    		 {
            "transaction_date" : "2022-11-22" ,
            "amount": 13.0,
            "currency_code": "SAR",
            "raw_description": "Apple Pay Mcdonalds ADNOC",
            "ref_id": "r2"
         }
    ]
}

201

application/json

Content type

{
    "transactions": [
        {
            "ref_id": "r1",
            "category_id": "10",
            "category_name": "Dining",
            "sub_category_id": "10-1",
            "sub_category_name": "Restaurants",
            "brand_id": 20157,
            "brand_name": "McDonalds",
            "brand_logo": "brand_logos/mcdonalds.png",
            "brand_url": "https://www.mcdonalds.com/",
            "global_tx_id": "9c838349-ce82-4c20-83d6-7fff6b3a5958"
        },
        {
            "ref_id": "r2",
            "category_id": "10",
            "category_name": "Dining",
            "sub_category_id": "10-1",
            "sub_category_name": "Restaurants",
            "brand_id": 20157,
            "brand_name": "McDonalds",
            "brand_logo": "brand_logos/mcdonalds.png",
            "brand_url": "https://www.mcdonalds.com/",
            "global_tx_id": "59f3c13a-139a-47c4-9414-28913a69b50d"
        }
    ]
}

Enriching Business Transactions

Query Params (Key)

Value

response-type

business

Enriches single or bulk transactions

AUTHORIZATIONS:

Api-key

REQUEST BODY SCHEMA :

application/json

transactions >
required

Array of objects (Bulk Transaction Objects) [ items ]

Array [

transaction_date

string (YYYY-MM-DD)

amount
‍required

float (Amount)

currency_code

string (Currency code) 3 charcters ISO currency code

raw_description
‍required

string (Raw Description)

ref_id

string (Reference ID)

]

Responses

RESPONSE SCHEMA :

application/json

transactions >

Array of objects (Bulk Transaction Objects) [ items ]

Array [

ref_id

string (Reference ID)

business_category_id

string (See All Business Main Categories) [ 1 .. 255 ] charcters

business_category_name

string (See All Business Main Categories)

business_sub_category_id

string (See All Business Sub-Categories) [ 1 .. 255 ] charcters

business_sub_category_name

string (See All Business Sub-Categories)

brand_id

Integer (Brand ID is a unique identifier)

brand_name

string (Brand Name)

brand_logo

The brand logo is concatenated with https://api.lunedata.io/media to get the actual image.

brand_url

string (Brand website URL)

global_tx_id

string (Global Transaction ID)

]

POST

https://api.lunedata.io/api/v2/transaction/enrich/?response-type=business

Payload

application/json

Content type

{
    "transactions" : [
         {
            "transaction_date" : "2022-12-25" ,
            "amount": -23.0,
            "currency_code": "AED",
            "raw_description": "Mcdonalds",
            "ref_id": "r1"
         },
    		 {
            "transaction_date" : "2022-11-22" ,
            "amount": 13.0,
            "currency_code": "SAR",
            "raw_description": "Apple Pay Mcdonalds ADNOC",
            "ref_id": "r2"
        }
    ]
}

201

application/json

Content type

{
    "transactions": [
        {
            "ref_id": "r1",
            "business_category_id": "B8",
            "business_category_name": "Meals & drinks",
            "business_sub_category_id": "B8-1",
            "business_sub_category_name": "Restaurants",
            "brand_id": 20157,
            "brand_name": "McDonalds",
            "brand_logo": "brand_logos/mcdonalds.png",
            "brand_url": "https://www.mcdonalds.com/",
            "global_tx_id": "37ce3c54-77eb-4d0a-baa0-65d78075b5a4"
        },
        {
            "ref_id": "r2",
            "business_category_id": "B8",
            "business_category_name": "Meals & drinks",
            "business_sub_category_id": "B8-1",
            "business_sub_category_name": "Restaurants",
            "brand_id": 20157,
            "brand_name": "McDonalds",
            "brand_logo": "brand_logos/mcdonalds.png",
            "brand_url": "https://www.mcdonalds.com/",
            "global_tx_id": "2d76dc98-3869-4d5f-81d9-3b1660a6f104"
        }
    ]
}

Response Status

- 200 Success : Standard response for successful HTTP requests.

- 400 Bad Request: The request cannot be fulfilled due to bad syntax.

List Of Consumer Main Categories

category_id (string)

category_name (string)

"1"

Financial Services

"2"

Charity & Gifts

"3"

Education

"4"

Entertainment

"5"

Government Services

"6"

Groceries

"7"

Wellness

"8"

Savings & Investments

"9"

Household

"10"

Dining

"11"

Shopping

"12"

Income

"13"

Transfer

"14"

Transportation

"15"

Travel

"16"

Loans

"17"

Insurance

"18"

Services

"19"

Miscellaneous

List of emirates

code (string)

name

AE-AZ

Abu Dhabi

AE-FU

Fujairah

AE-SH

Sharjah

AE-DU

Dubai

AE-RK

Ras Al Khaimah

AE-UQ

Umm Al Quwain

AE-AJ

Ajman

List Of Consumer Sub-Categories

sub_category_id (string)

sub_category_name (string)

Financial Services

"1-1"

Currency Exchange

"1-2"

Bank Fees

"1-3"

Financial Services

"1"

Other

Charity & Gifts

"2-1"

Donations

"2-2"

Gifting

"2"

Other

Education

"3-1"

University Tuition

"3-2"

School Fees

"3-3"

Books

"3-4"

Courses

"3-5"

Certifications

"3"

Other

Entertainment

"4-1"

Cinema

"4-2"

Theater

"4-3"

Concerts

"4-4"

Sport Events

"4-5"

Amusement Parks

"4-6"

Sport Activities

"4-7"

Comedy Shows

"4-8"

Pets

"4-9"

Gaming

"4-10"

Hobbies

"4-11"

Music Streaming

"4-12"

TV

"4-13"

Movie Streaming

"4-14"

Parks

"4"

Other

Government Services

"5-1"

Taxes

"5-2"

Government Fees

"5"

Other

Groceries

"6-1"

Supermarket

"6-2"

Convenience Store

"6-3"

Alcohol Shop

"6-4"

Tobacco Shop

"6-5"

Grocery Delivery

"6"

Other

Wellness

"7-1"

Medical

"7-2"

Pharmacy

"7-3"

GYM

"7-4"

Hair & Beauty

"7-5"

Dental

"7-6"

Mental Wellbeing

"7"

Other

Savings & Investments

"8-1"

Savings

"8-2"

Stocks

"8-3"

Long-term Deposits

"8-4"

Mutual Funds

"8-5"

Crypto

"8"

Other

Household

"9-1"

Rent

"9-2"

Electricity & Water

"9-3"

Internet

"9-4"

Phone Bill

"9-5"

Maintenance

"9-6"

Household Serivces

"9"

Other

Dining

"10-1"

Restaurants

"10-2"

Food Delivery

"10-3"

Coffeeshop

"10-4"

Nightlife

"10-5"

Shisha

"10-6"