Skip to content
View xyo-financial's full-sized avatar

Block or report xyo-financial

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Content in all repositories owned by your account will be closed.
Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
xyo-financial/README.md

XYO Developer Center

Deterministic Payment Transaction Enrichment & AI Categorization for Core Payment Rails

OpenAPI 3.0.3 Compliance Security Deterministic SDKs Sovereign Appliance License: Apache 2.0 Latency SLA p99 < 15ms

Welcome to the central developer and engineering portal for XYO Financial. Engineered for Tier-1 financial institutions, national clearing houses, card networks, and global enterprise banks, XYO delivers deterministic, sub-15ms transaction narrative parsing, merchant entity resolution, canonical brand assets, and multi-tier spend taxonomy directly inside live payment switches.


Executive & Architectural Strategy (For Lead Engineers & Systems Architects)

1. The Inline Switch Paradigm Shift

Legacy transaction enrichment vendors operate as post-clearing aggregators. They ingest batch ledger dumps hours or days after settlement, applying keyword matching or basic web scraping algorithms. Because their processing turnaround exceeds 250ms, they are architecturally excluded from participating in live payment authorization flows.

XYO is engineered from the silicon up for inline switch integration across modern and legacy payment rails:

  • Live Ingress Intercept: Operates synchronously within ISO 8583 card switches (Visa Base II, Mastercard IPM) and ISO 20022 real-time settlement rails (FedNow, RTP, Faster Payments, SEPA Instant).
  • Deterministic Sub-15ms p99 SLA: End-to-end processing turnaround executes within 5.4ms to 9.1ms (wire ingress in 1.2ms, neural matching in 3.4ms, and geospatial resolution in 1.8ms), comfortably below the strict 15ms authorization budget.
  • Inline Value Creation: Resolving cryptic terminal narratives into verified merchant hierarchies at the moment of authorization unlocks real-time fraud scoring, immediate first-party dispute mitigation, and instant mobile wallet notifications with verified logos.

2. The Nine-Figure Economic Rationale

For a Tier-1 retail bank or card issuer processing 10 Billion to 35 Billion transactions annually:

  • An enterprise software agreement of $20M to $25M annually across 25B transactions yields an effective unit cost of $0.0010 per transaction (one-tenth of a cent).
  • Direct Dispute Deflection ROI: Global card issuers expend between $15 and $45 per first-party dispute inquiry resulting from unrecognized transaction descriptors (such as cryptic billing strings or generic aggregator codes). Eliminating just 2 Million customer call-center inquiries per year delivers $30 Million to $60 Million in recurring operational savings, paying for the software agreement on dispute deflection alone.

3. Zero-Egress Sovereign Appliance Architecture

Global financial regulators strictly prohibit routing sensitive core payment switch feeds through shared multi-tenant SaaS clouds:

  • UK PRA & FCA: Supervisory Statement SS2/21 (Outsourcing and Third-Party Risk Management).
  • European Union: Digital Operational Resilience Act (DORA, Regulation (EU) 2022/2554) and EBA Guidelines on Outsourcing (EBA/GL/2019/02).
  • US Federal Reserve, FDIC & OCC: Interagency Guidance on Third-Party Relationships (OCC Bulletin 2023-17 / FRB SR 23-4).

Under these mandates, the XYO Sovereign Appliance deploys as a turnkey containerized appliance via enterprise Helm charts directly into the institution\x27s dedicated Virtual Private Cloud (AWS GovCloud, AWS Outposts, Azure Dedicated Hosts, Google Cloud Dedicated Interconnect) or bare-metal air-gapped datacenters. All neural model weights, merchant databases, and brand assets run locally in-memory with zero outbound network calls, guaranteeing 100% data sovereignty and zero PII egress.

4. The 90-Day Low-Risk Shadow Switch Pilot

Enterprise software architects can evaluate XYO with zero production risk via a 90-Day Shadow Switch Mirror:

  • A parallel, read-only mirror on live ISO 8583 or ISO 20022 feeds runs side-by-side with production switches.
  • Zero impact on live payment clearing or transaction settlement.
  • Empirical benchmark verification of p99 latency (< 15ms) and top-1 merchant disambiguation accuracy (> 99.8%) across tens of millions of live transactions.
  • Once performance gates are proven, switch circuit-breakers cut over seamlessly with zero operational disruption.

The Hand-Crafted Wrapper Architecture (Not Just Raw OpenAPI Code)

While the canonical OpenAPI 3.0 specification in xyo-financial/specs serves as the contract source of truth, raw generated client libraries from OpenAPI Generator CLI are never deployed to production alone in Tier-1 banking environments.

Every official XYO client library implements a Deterministic Two-Layer Architecture:

flowchart TD
    Spec["Canonical OpenAPI 3.0 Spec<br/>(xyo-financial/specs)"]
    
    subgraph Pipeline ["Automated CI/CD Sync (generate.yml)"]
        GenCLI["@openapitools/openapi-generator-cli"]
    end

    subgraph SDK ["Official Client Library"]
        subgraph GeneratedLayer ["Layer 1: Generated Transport (Read-Only)"]
            GenCode["- Low-level wire protocol<br/>- HTTP route definitions<br/>- Schema model serialization<br/>- Zero manual edits"]
        end
        
        subgraph WrapperLayer ["Layer 2: Industrial Systems Wrapper (Hand-Crafted)"]
            Wrapper["- Resilient circuit breaking & fail-open mechanisms<br/>- Industrial HTTP connection pooling & socket reuse<br/>- Deterministic memory management & zero-leak handles<br/>- RFC 7807 problem details to typed exception hierarchies<br/>- Pre-flight cardholder PAN / CVV ingress filtering<br/>- Idempotency keys & distributed W3C trace propagation<br/>- Exponential backoff with decorrelated jitter"]
        end
    end
    
    Consumer["Tier-1 Bank / Payment Switch / Core App"]

    Spec ==>|Trigger on Release Tag| GenCLI
    GenCLI ==>|Deterministically Emits| GeneratedLayer
    GeneratedLayer ==>|Encapsulated By| WrapperLayer
    WrapperLayer ==>|Sub-15ms Type-Safe Operations| Consumer
Loading

Layer 1: Machine-Generated Wire Protocol (/openapi, Read-Only)

Generated deterministically from the canonical OpenAPI 3.0 specification. Handles raw HTTP serialization, schema models, and baseline deserialization. Strictly immutable and synchronized via automated cross-repository workflows.

Layer 2: Hand-Crafted Industrial Wrapper (Production-Hardened)

A hand-engineered systems layer built by language and concurrency specialists for each respective runtime ecosystem, providing mission-critical enterprise capabilities:

  1. Resilient Circuit Breaking & Fail-Open Mechanics
    Equipped with configurable circuit breakers (Polly in .NET, Resilience4j in Java, atomic state machines in Go, Rust, and C++). If downstream enrichment encounters unexpected latency or saturation, the circuit trips and immediately fails open within 1.0ms, passing the raw transaction narrative untouched and guaranteeing that core payment authorizations are never blocked.

  2. Industrial HTTP Connection Pooling & Socket Management
    Configured with persistent HTTP keep-alive connection pools, pre-warmed TCP sockets, configurable maximum idle connections, proactive DNS refresh, backpressure regulation, and granular socket timeouts (connect, read, write, and TLS handshake budgets).

  3. Deterministic Memory Management & Zero-Leak Architecture
    Engineered to eliminate memory degradation during 24/7/365 continuous high-throughput execution:

    • C++ (C++17): Strict PIMPL idiom (std::unique_ptr<Impl>) ensuring zero ABI bleed, isolated dependencies, and zero memory leaks across billions of transactions.
    • Rust: Zero-allocation string slicing, lock-free concurrency, and Send + Sync thread safety.
    • Go: Native context.Context cancellation propagation, buffer pooling with sync.Pool, and zero heap-allocation spikes.
    • Java (Java 17+): Non-blocking java.net.http.HttpClient with reactive streaming pipelines and heap-friendly allocation profiles.
    • .NET 8+: High-throughput SocketsHttpHandler with pooled HTTP/2 framing, zero-allocation memory spans, and garbage-collection minimization.
    • Python (3.9+): High-throughput async and sync httpx transport with thread-offloaded JSON parsing.
    • Node.js: Zero runtime dependencies using native Web fetch with strict AbortController timeout budgets.
  4. Custom Banking Error Taxonomies (RFC 7807 Problem Details)
    Translates raw HTTP error payloads into rich, native typed exception hierarchies (AuthenticationException, RateLimitExceededException, MalformedNarrativeException, DownstreamTimeoutException, EngineCircuitBreakerException), fully populating RFC 7807 problem details (type, title, status, detail, instance).

  5. Pre-Flight Ingress Cardholder Guard (Luhn & CVV Filtering)
    Includes a client-side interceptor that validates transaction narratives against the Mod-10 Luhn algorithm and CVV regex patterns before bytes touch the wire. Any payload inadvertently containing raw Primary Account Numbers (PANs) or cardholder security codes is blocked client-side, enforcing PCI-DSS v4.0 compliance by design.

  6. Idempotency & Distributed Tracing
    Automatically provisions unique X-Idempotency-Key headers for safe transaction retries, alongside X-Correlation-ID and W3C Trace Context (traceparent) propagation for end-to-end visibility across Splunk, Datadog, Dynatrace, and OpenTelemetry collectors.

  7. Decorrelated Jitter Exponential Backoff
    Implements Full-Jitter and Decorrelated-Jitter backoff algorithms, preventing thundering herd spikes against enrichment clusters during upstream payment network recovery.


Official v2 Client SDK Matrix

All official XYO client SDKs are distributed under the open-source Apache 2.0 license:

Language / Platform Repository Installation Coordinate Generator Target Shipped Transport Concurrency Model
C++ (C++17) xyo-financial/sdk-cpp vcpkg install xyo-sdk / Conan cpp-restsdk (reference) Hand-written cpr / libcurl PIMPL pointer isolation, thread-safe
Rust xyo-financial/sdk-rust cargo add xyo-sdk rust (openapi-client) Hand-crafted reqwest + rustls Async tokio, Send + Sync, zero-copy
Go (Golang) xyo-financial/sdk-go go get github.com/xyo-financial/sdk-go/v2 go (openapi package) Hand-crafted net/http wrapper Goroutine safe, context.Context cancellation
Java (Java 17+) xyo-financial/sdk-java io.github.xyo-financial:xyo-sdk:2.1.0 java (native models) Hand-crafted java.net.http client Virtual threads / CompletableFuture, fluent
.NET / C# (.NET 8+) xyo-financial/sdk-dotnet dotnet add package Xyo.Sdk csharp Hand-crafted SocketsHttpHandler Async / await, Polly resilience policies
Python (3.9+) xyo-financial/sdk-python pip install xyo-sdk python Hand-crafted httpx wrapper Sync / Async, asyncio event loop
Node.js / TypeScript xyo-financial/sdk-node npm install xyo-sdk typescript-fetch Hand-crafted Web fetch Zero-dependency, Promise-based

For comprehensive architecture details, cross-repository dispatch workflows, and linter policies, see the SDK Architecture Guide and SDK Ecosystem Guide.


Canonical API Operations

Every official SDK provides type-safe access to XYO\x27s core enrichment engine through three canonical operations:

  1. Real-Time Single Enrichment (enrichTransaction)
    Synchronous enrichment designed for authorization switches and instant payment settlement (p99 < 15ms). Returns canonical merchant identity, verified logo URLs, multi-tier categories, MCC classification, carbon spend metrics, and geolocation coordinates.

  2. Asynchronous Bulk Ingestion (enrichTransactions)
    High-throughput bulk ingestion pipeline for batch settlement files, card network clearing dumps, and core banking nightly ledger reconciliation. Enriches up to 10,000,000 transactions within a 30-minute batch window.

  3. Deterministic Batch Polling (getEnrichmentStatus)
    Lifecycle tracking for batch jobs (PENDING, PROCESSING, COMPLETED, FAILED) with cryptographic checksum verification and secure signed download archives.


Idiomatic Code Examples

Go (Golang)

package main

import (
    "context"
    "fmt"
    "log"
    "time"

    xyo "github.com/xyo-financial/sdk-go/v2"
)

func main() {
    client, err := xyo.NewClient(
        xyo.WithAPIKey("xyo_live_corporate_secret_key"),
        xyo.WithTimeout(15*time.Millisecond),
        xyo.WithCircuitBreaker(xyo.CircuitBreakerOptions{
            FailureThreshold: 5,
            FailOpen:         true,
        }),
    )
    if err != nil {
        log.Fatalf("Failed to initialize XYO client: %v", err)
    }

    ctx, cancel := context.WithTimeout(context.Background(), 20*time.Millisecond)
    defer cancel()

    resp, err := client.EnrichTransaction(ctx, &xyo.EnrichmentRequest{
        Content:     "AMZN MKTP US*8A7B6C SEATTLE WA",
        CountryCode: "US",
    })
    if err != nil {
        log.Printf("Fallback to raw narrative: %v", err)
        return
    }

    fmt.Printf("Merchant: %s | Category: %s | Confidence: %.2f%%\n",
        resp.Merchant, resp.PrimaryCategory, resp.Confidence*100)
}

Java (Java 17+)

import io.github.xyo.sdk.XyoClient;
import io.github.xyo.sdk.model.EnrichmentRequest;
import io.github.xyo.sdk.model.EnrichmentResponse;

import java.time.Duration;

public class PaymentSwitchApplication {
    public static void main(String[] args) {
        XyoClient client = XyoClient.builder()
            .apiKey("xyo_live_corporate_secret_key")
            .timeout(Duration.ofMillis(15))
            .enableFailOpen(true)
            .build();

        EnrichmentRequest request = EnrichmentRequest.builder()
            .content("TFL TRAVEL CHAPS LONDON UK")
            .countryCode("GB")
            .build();

        EnrichmentResponse response = client.enrichTransaction(request);
        System.out.println("Enriched Merchant: " + response.getMerchant());
        System.out.println("Legal Entity: " + response.getLegalEntityName());
    }
}

C++ (C++17)

#include <iostream>
#include <xyo/client.hpp>

int main() {
    xyo::ClientConfig config;
    config.api_key = "xyo_live_corporate_secret_key";
    config.timeout_ms = 15;
    config.fail_open = true;

    xyo::Client client(config);

    xyo::EnrichmentRequest req;
    req.content = "UBER *TRIP HELP.UBER.COM NL";
    req.country_code = "NL";

    auto outcome = client.enrich_transaction(req);
    if (outcome.is_success()) {
        const auto& data = outcome.value();
        std::cout << "Merchant: " << data.merchant << " (" << data.confidence << "%)\n";
    } else {
        std::cerr << "Fail-open fallback: " << outcome.error().message() << "\n";
    }

    return 0;
}

Institutional Deployment Topologies

XYO supports three deployment models calibrated to regulatory jurisdiction, network isolation, and transaction scale:

Deployment Topology Infrastructure Network Isolation Primary Regulatory Alignment
Sovereign Appliance Self-hosted Kubernetes / OpenShift via Helm v3 Zero-Egress air-gapped VPC or on-premises bare metal Bank of England PRA SS2/21, EU DORA, US OCC 2023-17, China PIPL
Dedicated VPC Enclave Single-tenant dedicated cloud cluster AWS PrivateLink / Azure ExpressRoute / mTLS PCI-DSS v4.0 Level 1, SOC 2 Type II, ISO 27001
Public Edge API Multi-tenant global edge nodes Public TLS 1.3 with automated rate limiting Fast-growth FinTechs and neobanks

Explore deployment manifests and installation guides in the Helm Chart Repository and Onboarding Guides.


Security, Regulatory Compliance & Governance

  • πŸ” Cryptographic Standards: TLS 1.3 with Perfect Forward Secrecy (PFS) in transit; AES-256-GCM encryption at rest under FIPS 140-3 validated key management.
  • πŸ”‘ Zero-Trust Authentication: Dual-mode support for Mutual TLS (mTLS x509 certificates) and cryptographically provisioned rotating Bearer tokens.
  • πŸ›‘οΈ Zero-Retention Volatile Execution: Transaction payloads are processed exclusively within volatile RAM and evicted immediately upon response delivery. Zero customer data or cardholder information is ever written to non-volatile disk or pooled for AI training.
  • πŸ“œ Global Regulatory Compliance: Complete adherence to PCI-DSS v4.0 Level 1, SOC 2 Type II, ISO/IEC 27001, Bank of England / PRA SS2/21, EU DORA & GDPR, US OCC 2023-17 / GLBA / NYDFS 23 NYCRR 500, Saudi SAMA CSF, and China PIPL.

For detailed regulatory frameworks across the UK, US, Germany, China, and Saudi Arabia, consult the Global Compliance Guide and Security Policy.


Licensing & Governance

  • Client SDK Suite: Distributed under the open-source Apache License, Version 2.0.
  • Enterprise Appliance & Core Engine: Proprietary software licensed under the XYO Financial Master Services Agreement (MSA).
  • Source Code Escrow: Three-way institutional software escrow managed through NCC Group or Iron Mountain for qualified enterprise agreements.

Copyright Β© 2026 Syniol Limited. All rights reserved.

Pinned Loading

  1. sdk-cpp sdk-cpp Public

    an Official XYO Financial SDK for C++ Language

    C++

  2. sdk-go sdk-go Public

    an Official XYO Financial SDK for Go (Golang)

    Go

  3. sdk-java sdk-java Public

    an Official XYO Financial SDK for Java Programming Language

    Java

  4. sdk-rust sdk-rust Public

    an Official XYO Financial SDK for Rust Language

    Rust