Library

Transaction enrichment library for Swift

Use TxnKit as a transaction enrichment API from Swift. This page shows the safe request shape, a short code snippet, and the boundary for keeping sensitive data out of the integration.

Ask about a 100-descriptor cleanup auditInspect the API

Target intent

Swift developers using a server-owned API key or trusted backend to enrich transaction display rows.

TxnKit API keys should not be embedded in distributed mobile apps.

Raw descriptor

SQ *JOES COFFEE 0421 TORONTO

Short Swift API snippet

var request = URLRequest(url: URL(string: "https://api.txnkit.dev/v1/enrich")!)
request.httpMethod = "POST"
request.setValue("Bearer \(txnkitApiKey)", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try JSONSerialization.data(withJSONObject: [
  "raw_description": "SQ *JOES COFFEE 0421 TORONTO",
  "country": "CA"
])

let (data, _) = try await URLSession.shared.data(for: request)

Keep API keys out of browser bundles. For frontend stacks, call a backend route or serverless function that owns the TxnKit request.

API-shaped output

{
  "normalized_merchant": "joes coffee",
  "display_name": "Joes Coffee",
  "category": null,
  "subcategory": null,
  "website": null,
  "logos": {
    "preferred": null,
    "variants": [],
    "warnings": [
      "no_verified_logo_for_local_merchant"
    ]
  },
  "confidence": 0.56,
  "recurring_hint": false,
  "processor_hint": "square",
  "location_hint": {
    "city": "Toronto",
    "country": "CA"
  },
  "signals": [
    "applied_processor_square_sq_star",
    "removed_reference_tokens"
  ],
  "warnings": [
    "local_merchant_identity_not_verified"
  ]
}

Low-confidence results should keep fallback labels and warnings visible instead of forcing a guessed logo or website.

When to use

  • You are building in Swift and need one-descriptor merchant cleanup through an HTTP API.
  • Your app can keep the TxnKit API key on the server side or inside a trusted serverless function.
  • You need merchant display names, categories, confidence, signals, warnings, and logo-ready metadata.

When not to use

  • TxnKit API keys should not be embedded in distributed mobile apps.
  • Do not use TxnKit to process card numbers, account numbers, full statements, bank credentials, emails, phone numbers, addresses, customer names, or customer PII.
  • Do not use TxnKit when the product requirement is guaranteed merchant identity, every-merchant resolution, or contracted uptime terms.

Proof surfaces

The public contract is POST /v1/enrich, backed by the OpenAPI file, benchmark examples, privacy rules, and deterministic request-path tests.

OpenAPI · Benchmark · Security · Pricing

Related pages