Skip to main content
POST
brand.transaction.enrich

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
descriptor
string
required

Card or bank descriptor; may contain personal data.

Required string length: 1 - 1024
countryHint
string

Country hint for ambiguous names, not a restriction on merchant country.

Required string length: 1 - 2
context
object

Actual transaction context. All four transaction fields are required; no values are invented.

includeLogos
boolean
default:false

Copy up to three available merchant, parent and intermediary logos. Explicit; worst-case lookup cost $0.06.

Response

The result

status
enum<string>
required

Merchant identified, or descriptor cleaned without a merchant domain.

Available options:
matched,
cleaned
merchant
object
required

Merchant or cleaned display name.

matchMethod
enum<string>
required

Lookup stage that produced the answer.

Available options:
context,
domain,
entity,
name,
cleanup
entityType
enum<string>

Counterparty type when context enabled classification.

Available options:
person,
organization
parent
object

Nearest known owner, not necessarily the top-level owner.

intermediary
object

Known platform through which the purchase ran.

matchConfidence
number

Merchant match confidence, only for an explicitly classified organization; never a score for a person.

Required range: 0 <= x <= 1