View Enriched Data
View Enriched Data
GET
https://api.synapsefi.com/v3.1/enrich/:merchant_id
This endpoint allows you to view detailed merchant information for entity_id
, facilitator_id
, location_id
or biller_id
.
Headers
Name
Type
Description
Content-Type
string
This value should be application/json
{
"_id": "5d27c72e715467f6ef157bee",
"address": {
"city": "Louisville",
"country_code": "US",
"loc": [
38.21362,
-85.53173
],
"postal_code": "40299",
"street1": "2002 Papa John's Blvd",
"street2": null,
"subdivision": "KY"
},
"analytics": {},
"logo": "https://cdn4.synapsefi.com/uploads/2019/12/07/FCJGO20MsILNdrqaPTHQD3bAkpo9lSKuRghY68WtnX1e7B5fmv.png",
"name": "Papa John's Pizza",
"official_page": "https://www.papajohns.com/",
"phone_number": {
"country_code": "1",
"national_number": "8775477272"
},
"scope": "entity"
}
Entity, Facilitator or Location IDs are returned as a part of a card transaction stream. These values are located either in from.meta.enriched_info
in case of a push transaction or to.meta.enriched_info
in case of a pull transaction.
For instance, for a transaction description like PAYPAL *NETFLIX.COM 4029357733 CA 950327620
, enriched_info
will look like the following:
// PAYPAL *NETFLIX.COM 4029357733 CA 950327620
{
"enriched_info": {
"category": "entertainment",
"entity_id": "5bde7b198ddd931c7ee7d0df", // Netflix
"facilitator_id": "5bde7b198ddd931c7ee7d0e0", // Paypal
"location_id": null,
"status": "SETTLED"
}
}
A Biller ID on the other hand is the _id
returned on View Billers API call.
Example Request
GET /v3.1/enrich/5d27c72e715467f6ef157bee HTTP/1.1
Host: qa-api.synapsefi.com
Content-Type: application/json
Last updated
Was this helpful?