# Integrate using AI Use Axiym documentation and an optional integration prompt with your coding agent. Product: Account API Guides follow API reference 0.1.0 and event reference 0.1.0. Canonical page: https://docs.sandbox.axiym.io/account-api/integration-guide/integrate-with-ai Use the sources below with your coding agent to build an Account API integration. ## AI-readable documentation | Source | Use it for | | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | [Account API llms.txt](/account-api/llms.txt) | Finding guides, references and available versions. | | [Markdown pages](/account-api/integration-guide/quick-start.md) | Reading guides and examples. Use **View Markdown** or append `.md` to a documentation page URL. | | [OpenAPI contracts](/account-api/api-reference#downloads) | Versioned operations and request/response schemas. | Markdown is generated from the same sources as this site. Give your agent the relevant links; `llms.txt` is not automatically read by every tool. If it cannot fetch a page, paste the Markdown instead. ## Describe one feature at a time Include your feature goal and application constraints. For example: > Add Account API conversion quoting to our treasury dashboard. Discover > permitted pairs and show the returned quote for review using our existing > backend client and UI patterns. Leave confirmation for a separate step. For larger integrations, work incrementally through account discovery, conversion review and confirmation, deposits, and withdrawals. ## Optional integration prompt Copy the prompt into your coding agent with your repository open. Add your feature goal; the prompt supplies documentation links and Account API guidance. **AI assistance does not guarantee a correct integration** Generated code may contain errors or miss requirements. Review it against the API documentation and validate it in the sandbox before production use. This prompt does not validate or certify your integration. ```text Help me integrate the Axiym Account API into the application in this repository. Implement only the feature I describe alongside this prompt. If I have not supplied a feature goal, ask what I want to build before choosing the scope. Follow the application's existing architecture and conventions. ## Start with the application Inspect the repository's instructions, language, framework, HTTP client, configuration, authentication and authorization, persistence, background jobs, and tests. Find any existing Axiym integration before adding another one. Reuse the project's established components and libraries. Explain where the integration will fit and then implement it. Ask focused questions only when a missing decision materially changes the implementation. If no application repository is available, ask which project to use before creating a new application. If this is a backend-only project, implement the appropriate service/API interfaces and document how a caller supplies the review and confirmation decision. ## Read the Axiym sources Target Account API 0.1.0 and event reference 0.1.0. These versions were selected when this prompt was copied. Use matching contracts and verify that current guides still describe those versions. Flag any mismatch and establish the intended version before implementing. Start with: - Documentation index: https://docs.sandbox.axiym.io/account-api/llms.txt - Getting started: https://docs.sandbox.axiym.io/account-api/integration-guide/quick-start.md - Access and environments: https://docs.sandbox.axiym.io/account-api/integration-guide/access-setup.md - Sandbox validation: https://docs.sandbox.axiym.io/account-api/integration-guide/sandbox-testing.md - API contract: https://docs.sandbox.axiym.io/openapi/account-api/0.1.0.yaml - Event contract: https://docs.sandbox.axiym.io/openapi/account-api/events/0.1.0.yaml Read the guides relevant to the requested feature: - Authentication: https://docs.sandbox.axiym.io/account-api/integration-guide/fundamentals/authentication.md - Idempotency: https://docs.sandbox.axiym.io/account-api/integration-guide/fundamentals/idempotency.md - Errors and retries: https://docs.sandbox.axiym.io/account-api/integration-guide/fundamentals/error-handling-and-retries.md - Pagination: https://docs.sandbox.axiym.io/account-api/integration-guide/fundamentals/pagination-and-query-parameters.md - Address book: https://docs.sandbox.axiym.io/account-api/integration-guide/add-to-address-book.md - Deposits: https://docs.sandbox.axiym.io/account-api/integration-guide/deposit-funds.md - Conversions: https://docs.sandbox.axiym.io/account-api/integration-guide/execute-a-conversion.md - Withdrawals: https://docs.sandbox.axiym.io/account-api/integration-guide/withdraw-funds.md - Reconciliation: https://docs.sandbox.axiym.io/account-api/integration-guide/reconcile-activity.md - Webhook registration: https://docs.sandbox.axiym.io/account-api/webhooks/registration-management.md - Webhook signatures: https://docs.sandbox.axiym.io/account-api/webhooks/verifying-signatures.md - Webhook processing: https://docs.sandbox.axiym.io/account-api/webhooks/overview.md Use these sources for endpoints, schemas, scopes, states, signature verification and retry rules. Follow linked operation and schema references for field details. If sources conflict or cannot be retrieved, identify the gap and ask for the missing information. Do not invent endpoints, an Axiym SDK or undocumented behavior. ## Implement the requested functionality Apply only the guidance relevant to the requested feature, in manageable steps. Use the existing server-side HTTP stack and configuration or secret store. Derive authentication and environment URLs from the documentation. Keep credentials and tokens server-side, omit secrets from logs, and supply empty example configuration values. Represent monetary values without floating-point rounding errors. 1. Use your organization's credentials and the documented Account API paths to access its Axiym accounts and API resources. Register external bank accounts and wallets for whitelisting. Axiym performs due diligence and compliance checks before an external account becomes ACTIVE and can fund deposits or receive withdrawals. 2. Discover active Axiym accounts, permitted conversion pairs, and whitelisted external accounts in the address book. Only ACTIVE external accounts may fund deposits or receive withdrawals. Match conversion direction by currency and payment rail, using the returned pairId. Do not reverse a pair or treat destinationId as an Axiym account identifier. Use the account's documented deposit instructions for its rail and network. 3. For conversions, retain the create response for review: an unconfirmed quote is not returned by later read operations. Keep confirmation as a separate explicit decision before the quote expires. Creation locks a rate; confirmation starts execution. An expired quote requires a new conversion. 4. For withdrawals, verify that the source Axiym account belongs to your organization and that the external account is registered in its address book, whitelisted, and ACTIVE. Check both accounts' status and currency, and the wallet network where applicable. Do not require the external account to have the same owner as the Axiym account. Create, review, and explicitly confirm as separate steps. Preserve identifiers and distinguish pending execution from a terminal outcome. 5. Use distinct idempotency keys for creation and confirmation; retry each exact operation with its original key. Track events using the documented signature verification and deduplication rules, retrieve authoritative resource state where available, and reconcile conversion debits and credits and withdrawal debits with account statements. The conversion.created event is emitted after confirmation, when execution has begun. Use the retained create response for an unconfirmed conversion and fetch the resource only after confirmation. Confirm the supported sandbox bank simulations and blockchain test networks with Axiym. ## Verify and hand over Use mocked responses and synthetic fixtures derived from the selected contracts. Test authentication, authorization, pagination and error handling as relevant, plus pair direction and payment-rail selection, unauthorized access to API resources, unregistered or inactive external accounts, quote expiry, creation without automatic confirmation, ambiguous responses, unsuccessful withdrawals, duplicate or out-of-order events, and statement reconciliation. For webhook features, cover invalid signatures and recovery from missed notifications. Run the project's relevant checks and fix failures caused by your changes. Code generation and local tests should not require real credentials. Leave live API calls, webhook registration, deployment and money movement for separately requested setup or validation. Finish with changed files, configuration instructions, checks actually run, assumptions and remaining gaps. Distinguish passing local tests from a verified sandbox integration, and list the provisioning and application decisions still needed. ``` ## Review and validate Passing local tests does not verify an Axiym integration. Use the [quickstart](/account-api/integration-guide/quick-start) and [sandbox testing guide](/account-api/integration-guide/sandbox-testing) to validate your selected flows with provisioned access.