Axiym

Axiym Account API

View Markdown

Use the Account API to view Axiym accounts, registered address book entries, and account activity; retrieve deposit instructions and track deposits; create and confirm withdrawals; and receive webhook notifications. The access token identifies the organization that owns every account, address book entry, deposit, withdrawal, and webhook subscription.

Deposit flow

  1. Retrieve the receiving details with GET /accounts/{accountId}/deposit-instructions.
  2. Send the funds from an ACTIVE address book entry using those details.
  3. Track the incoming payment with GET /deposits and GET /deposits/{depositId} or deposit webhooks.

Withdrawal flow

  1. Select an ACTIVE source account and an ACTIVE address book entry in the same currency.
  2. Create the withdrawal with POST /withdrawals. The response returns its withdrawalId in PENDING_CONFIRMATION status.
  3. Confirm that identifier with POST /withdrawals/{withdrawalId}/confirm to begin execution.
  4. Track the outcome with GET /withdrawals/{withdrawalId} or withdrawal webhooks.

Downloads

OpenAPI contract

v0.3.0 · current

Explore the schema or generate a client for your integration.

Download OpenAPI

Postman collection

v0.3.0 · current

Import ready-to-use requests and connect to the sandbox.

Download collection

Environments

Sandboxhttps://partner-api.sandbox.axiym.io/api/v1
Productionhttps://partner-api.axiym.io/api/v1

Resources

Auth

OAuth 2.0 client credentials authentication.

Accounts

Axiym accounts, balances, and posted ledger activity.

Address Book

Registered external bank accounts and wallet addresses you own — the permitted deposit sources and withdrawal destinations.

Deposits

Incoming funds credited to your Axiym accounts.

Withdrawals

Outgoing payments from Axiym accounts to registered address book entries.

Webhook Subscriptions

Webhook subscription management and webhook public keys.

On this page

Deposit flowWithdrawal flowDownloadsEnvironmentsResources