API Reference triple v#1.0.0

Copy Markdown View Source

Modules

Elixir client for the Triple transaction data enrichment API.

Brand lookups — fetch a brand's canonical name/logo by id.

Low-level HTTP plumbing for the Triple API, built on Req.

Configuration for a Triple client.

Cryptocurrency lookups by slug.

Transaction enrichment — the core of the Triple API.

A structured error returned (or raised, via the ! functions) for every failure mode this library can produce: local validation failures, Triple API error responses, and transport-level failures.

Report incorrect or missing enrichment data back to Triple, helping its models improve over time.

Optional, opt-in client-side rate limiting.

Brokerage product (stock/fund) lookups by ISIN.

Issues mTLS client certificates against Triple's control-plane host (a different host from the main enrichment/data API — see Triple.Config).

:telemetry events emitted by this library. Attach handlers the usual way to get logging, metrics, or tracing for free.

A brand resource as returned by GET /v1/brands/{id}/.

A cryptocurrency resource as returned by GET /v1/cryptos/{slug}/.

Request payload for POST /v1/enrich-transaction/ — structured transaction enrichment.

Response payload for POST /v1/enrich-transaction/.

Structured merchant address (card acceptor location).

Estimated CO2 emissions for the transaction.

A single transaction category label.

Merchant contact details.

Latitude/longitude pair (lat/lon) for a merchant location.

Fraud signal for the merchant.

Location enrichment. Online (ECOMMERCE) transactions never carry a location, so enabled?/1 will be false for those.

Identified intermediary payment processor/gateway (e.g. PayPal, SumUp), if any.

Recurring payment / subscription detection.

Visual branding enrichment: clean merchant name, logo, etc.

Request payload for POST /v2/enrich-unstructured-transaction/ — free-text transaction enrichment, for when all you have is a raw description string rather than discrete merchant fields.

Response payload for POST /v2/enrich-unstructured-transaction/.

Identified merchant brand.

CO2 emissions estimate (v2 shape — flat).

A single transaction category label (v2 shape).

Brand/processor contact details (v2 shape — flat, no enabled flag).

Fraud signal (v2 shape — flat).

Merchant location (v2 shape — flat fields).

Identified payment processor (v2 shape).

Recurring-payment detection (v2 shape — flat, singular).

Request payload for POST /v1/customer-feedback/ — report enrichment data that is missing or wrong for a given transaction.

A single visual asset (logo), returned for both stocks and cryptos in one of four formats.

A stock/fund resource as returned by GET /v1/stocks/{isin}/.

A TLS certificate as returned by POST /v1/tls-certificates/ (HTTP 201).

Request payload for POST /v1/tls-certificates/ (control-plane host) — issues a new mTLS client certificate.

Small stateless helpers shared across the Triple client.