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.

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

Mission-Critical Financial Transaction Enrichment & AI Categorization Engine

OpenAPI 3.0.3 Compliance Security Deterministic SDKs License: Apache-2.0 SDK v2.0.x

Welcome to the central developer portal for XYO Financial's API specifications, SDK libraries, and enterprise integration guides. Engineered for Tier-1 financial institutions, national payment switches, and global card issuers, XYO provides deterministic, low-latency transaction narrative parsing, merchant disambiguation, geolocation resolution, and neural categorization.


πŸ›οΈ Architecture & Deployment Topologies

XYO supports flexible deployment architectures aligned with regional data residency, regulatory mandates (OCC 2023-17, PRA SS2/21, DORA, China PIPL), and high-throughput requirements:


πŸ›  Official v2 Client SDKs

All XYO client libraries are generated deterministically from our canonical OpenAPI specification and wrapped in ergonomic, idiomatic interfaces. Each SDK provides thread-safe operations, connection pooling, automated retry logic with exponential backoff, and full mock integration test suites.

Language / Platform Repository Installation Version Status
C++ (C++17) xyo-financial/sdk-cpp CMake / Conan / vcpkg v2.1.0 Stable
Rust xyo-financial/sdk-rust cargo add xyo-sdk v2.1.0 Stable
Go (Golang) xyo-financial/sdk-go go get github.com/xyo-financial/sdk-go/v2 v2.1.1 Stable
Java (Java 17+) xyo-financial/sdk-java com.xyo.financial:xyo-sdk:2.1.0 v2.1.0 Stable
.NET / C# (.NET 8+) xyo-financial/sdk-dotnet dotnet add package Xyo.Sdk v2.1.0 Stable
Python (3.9+) xyo-financial/sdk-python pip install xyo-sdk v2.1.0 Stable
Node.js / TypeScript xyo-financial/sdk-node npm install xyo-sdk v2.1.0 Stable

For architectural standards, deterministic code generation mechanics, and benchmarking, refer to the SDK Architecture Guide.


⚑ Canonical API Operations

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

  1. Real-Time Single Enrichment (enrichTransaction)
    Synchronous enrichment for authorization streams and real-time payment settlement (P99 < 10ms). Returns merchant name, normalized branding/logos, confidence scores, MCC codes, and geolocation.

  2. Asynchronous Bulk Enrichment (enrichTransactions)
    High-throughput asynchronous batch submission for settlement files, core banking feeds, and nightly ledger processing. Returns a cryptographically tracked batch ID and downloadable archive link.

  3. Batch Status Polling (getEnrichmentStatus)
    Deterministic job lifecycle tracking (READY, PENDING, FAILED) to retrieve completed enrichment archives with built-in checksum verification.


πŸ“– API Specifications & Developer Tooling

Our OpenAPI specifications serve as the single source of truth across all platforms and integrations:

  • Specs Repository
    Central repository for API contracts, schema validation tools, and contract-testing fixtures.
  • OpenAPI 3.0.3 Specification
    Hardened schema featuring comprehensive banking fixtures (ISO 8583 / ISO 20022 transaction narratives) and strict RFC 7807 problem details.
  • Postman Collection
    Production-ready collection configured with Bearer and mTLS authentication profiles, parameter sets, and payload templates.

πŸ”’ Security, Compliance & Governance

  • πŸ” Encryption & Cryptographic Standards
    All data in transit is enforced via TLS 1.3 with Perfect Forward Secrecy (PFS); data at rest is encrypted using AES-256-GCM under FIPS 140-3 validated key management.

  • πŸ”‘ Authentication & Access Control
    Dual-mode enterprise authorization supporting Mutual TLS (mTLS x509 certificates) and cryptographically provisioned Bearer tokens (Authorization: Bearer <token>) with automated rotation policies.

  • ⚠️ Error Semantics & Resilience
    Standardized RFC 7807 Problem Details (application/problem+json) across all HTTP status codes, coupled with idempotent request handling (X-Idempotency-Key) and distributed trace correlation (X-Correlation-ID).

  • πŸ“œ Regulatory Compliance & Data Sovereignty
    Full alignment with PCI-DSS v4.0, SOC 2 Type II, ISO/IEC 27001, UK/EU GDPR & DORA, US GLBA / OCC 2023-17, Saudi SAMA CSF & PDPL, and China PIPL / DSL. Structured operational logging and distributed tracing are used, but zero raw customer transaction data or PII is ever logged (enforced via masking/redaction) to prevent cross-border data leakage.

For detailed regulatory frameworks across UK, US, Germany, China, and Saudi Arabia, see the Global Compliance & Data Sovereignty Guide.


πŸ“„ Licensing & Legal Notice

  • Client SDKs: 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) and Enterprise Evaluation Agreement.

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