</>DOCUMENTATION

Build on tPay365

API references, integration guides, and technical documentation for employers and developers building on obligation-first payroll infrastructure.

Join the Developer Waitlist View OpenAPI Spec

https://api.tpay365.com/api/v1

Documentation

Everything you need to integrate

API Reference

Complete endpoint reference for authentication, payroll ingestion, vault operations, and all 14 API groups.

Available at Launch

Employer Integration Guide

Step-by-step guides for connecting your HRIS, uploading BACS files, and managing employee enrolment.

Available at Launch

Provider Integration Guide

Connect your platform to tPay365 as a subscription provider. Receive priority payments from ring-fenced vaults.

Available at Launch

SDKs & Libraries

Official client libraries for Python, Node.js, TypeScript. Auto-generated from the OpenAPI 3.1 spec.

Coming Soon

Webhooks

Real-time event notifications for payment success, vault changes, employee lifecycle, and more.

Available at Launch

Sandbox & Testing

A full sandbox environment that mirrors production. Test credentials, seed data, and predictable test modes.

Available at Launch

API Reference

14 endpoint groups. One consistent contract.

Endpoint Groups

Auth & Identity

User & Profile

Payroll IngestionComing Soon

Clean Paycheck Engine

Vault Operations

Debt CrusherComing Soon

Affordability PilotComing Soon

Yield EngineComing Soon

Payment ExecutionComing Soon

Allocation & WithdrawalsComing Soon

Reliability CredentialComing Soon

Employer BenefitsComing Soon

Legacy Data & OCRComing Soon

Admin & Audit

Live at LaunchComing Soon

POST /api/v1/engine/paycheck/calculate

http

POST /api/v1/engine/paycheck/calculate HTTP/1.1
Host: api.tpay365.com
Authorization: Bearer sk_live_...
Content-Type: application/json

{
  "employee_id": "emp_8821-9920",
  "gross_pay": 285000,
  "obligations": [
    { "type": "RENT", "amount": 95000 },
    { "type": "ENERGY", "amount": 12500 },
    { "type": "NETFLIX", "amount": 1599 }
  ]
}

Response — 200 OK

json

{
  "clean_paycheck": {
    "gross_income": 285000,
    "vault_total": 109100,
    "buffer": 5450,
    "vaults": [
      { "type": "RENT", "amount": 95000 },
      { "type": "ENERGY", "amount": 12500 },
      { "type": "NETFLIX", "amount": 1599 }
    ],
    "safe_to_spend": 170450
  }
}

Integration

Choose your integration path

For Employers (HRIS Integration)

Connect your payroll system once. tPay365 handles the rest.

Workday — API connector
ADP — Webhook + file ingestion
Xero — OAuth + payroll sync
CSV Upload — Universal fallback

Read Employer Guide →

For Developers (API Integration)

Build tPay365 into your product. Full REST API with OpenAPI 3.1 schema.

RESTful JSON API
OAuth 2.0 authentication
Webhook event system
Sandbox environment

Read API Reference →

Security

Enterprise-grade by default

OAuth 2.0 + API Keys

Bearer token auth for all endpoints. Scoped API keys for server-to-server.

Signed Webhooks

Every webhook payload is HMAC-signed. Verify before processing.

TLS 1.3 + mTLS

All traffic encrypted. Mutual TLS between internal services.

PII Isolation

Split-key architecture. No single server holds complete user data.

Developer Experience

Built for developers who ship

Interactive Explorer

Try any endpoint directly from the browser. Swagger UI with pre-populated test data.

GET/api/v1/auth/me

POST/api/v1/engine/paycheck

GET/api/v1/vault/{ref}

Typed SDKs

Auto-generated from our OpenAPI spec. Full TypeScript types. Python Pydantic models.

from tpay365 import Client

client = Client("sk_live_...")

Changelog & Versioning

Every API change is logged. Breaking changes are versioned. You'll never be surprised.

v2.1.0Feb 2026

Added batch vault operations, webhook retry policies, and employer dashboard metrics endpoint.

</>Coming Soon

Documentation launches with the platform

Get notified when the full docs site goes live — including sandbox access.

Join the Developer Waitlist

We'll also send early API access to developers on the waitlist.