This Axys API Reference section documents every published endpoint in the Program-level API: operations grouped across Cardholder Management, Cardholder Compliance, Card Deposit Channels, Card Management, Card Security, Card Transactions, Wallet Management, and Wallet Transactions.
This page provides orientation for the API Reference section. If you've arrived here before reading the conceptual documentation, the links below are the right starting points.
Before you use the Reference
The API Reference section assumes you understand:
- The hierarchy: Tenant → Program → Cardholder → Card/Wallet — see Program Architecture
- Authentication: every request requires a valid mTLS client certificate and
X-API-Keyheader — see Authentication & Environments - Amount formatting: all monetary values are decimal-implied integers (e.g.
1000= $10.00 in USD) — see Accounts, Wallets & Deposit Addresses - Program scoping: the API Key determines which Program's data is visible — there's no
programIdparameter — see Program Architecture
Endpoint groups
| Group | What it covers |
|---|---|
| Cardholder Management | Create, retrieve, edit, update, and delete Cardholders; list with filters |
| Cardholder Compliance | Submit to compliance, retrieve/refresh KYC URL, manage compliance lifecycle |
| Card Deposit Channels | Register bank accounts for fiat deposits (register wallet address: deprecated) |
| Card Management | Issue virtual/physical Cards, retrieve Card data (masked and sensitive), get status and balance, update alias/limits |
| Card Transactions | Get filtered Card transactions, Card fees; bank-deposit trace notifications (blockchain deposit: deprecated) |
| Card Security | Activate a Card, update PIN, block/unblock, subscribe to 3-DS OTP |
| Wallet Management | Create Wallets, retrieve individual Wallets and full wallet list |
| Wallet Transactions | Transfer funds from Wallet; bank-deposit trace notifications (blockchain deposit: deprecated) |
Deprecated endpoints
Three endpoints are deprecated and should not be used in new integrations. They remain functional for existing integrations with replacement guidance noted in the Reference itself:
| Deprecated endpoint | Replaced by |
|---|---|
POST /cardholders/{cardholderId}/register-wallet-address | Automatic per-Card Deposit Address generation at issuance |
POST /cards/{cardId}/deposit | Automatic multi-chain STP — no call needed |
POST /wallets/{walletId}/deposit | Automatic multi-chain STP — no call needed |
See Versioning & Deprecations for the full context.
Account Management
The Account Management layer covers Programs, Card Designs, API Users, certificates, the IP allowlist, fee configuration, support tickets, and billing. It operates on separate, non-publicly-exposed endpoints available only to Tenants with production API Keys. It is not part of this API Reference section. See API Users, Tenants & Programs.
Reference supplements
The following pages complement the endpoint Reference with lookup tables, definitions, and a data model:
| Page | What's in it |
|---|---|
| Index | Alphabetical index of fields, endpoints, concepts, and terms |
| Glossary | Definitions for every term used across this documentation |
| Statuses & Enums | Every integer enum across the API — Cardholder status, Card status, currency, gender, etc. |
| Errors & Status Codes | HTTP status code reference with API-specific context (under Guides) |
| Data Model & Object Reference | ER diagram + field-level tables for every API object |
| ISO Code Conventions | Country codes, calling codes, currency conventions |
| Support Tickets | The platform's integrated support ticketing system |
| Versioning & Deprecations | Version policy and current deprecations (under Guides) |