# Anton Payments

## Docs

- [Retrieve a Funding Account](https://docs.antonpayments.com/api-reference/accounts/get-account.md): Return the funding account for a single currency.
- [Retrieve Deposit Details](https://docs.antonpayments.com/api-reference/accounts/get-account-details.md): Return the banking / deposit details for your funding account in this currency — IBAN/BIC, sort code + account number, routing codes, etc. Share these with the sender to fund your balance.
- [List Account Transactions](https://docs.antonpayments.com/api-reference/accounts/list-account-transactions.md): Cursor-paginated list of transactions for this funding account — deposits from external parties, payout debits, fee deductions, and FX transfers.
- [List Funding Accounts](https://docs.antonpayments.com/api-reference/accounts/list-accounts.md): Return your virtual funding accounts — one per currency Anton has provisioned for you. Used for depositing funds into your merchant balance.
- [List All Transactions](https://docs.antonpayments.com/api-reference/accounts/list-transactions.md): Cursor-paginated list of transactions across every funding account you hold. Only `limit` and `cursor` are honored; server-side filtering by currency, type, or time range is not yet supported — filter client-side on the returned `MerchantTransaction` objects, or call `GET /v1/accounts/{currency}/tra…
- [Retrieve a Balance](https://docs.antonpayments.com/api-reference/balances/get-balance.md): Return your merchant balance in a single currency.
- [List Balances](https://docs.antonpayments.com/api-reference/balances/list-balances.md): Return your merchant balance in every currency you hold. Each balance distinguishes between `available` (usable for new payouts), `pending` (reserved for in-flight payouts), and `total`.
- [Cancel a Batch](https://docs.antonpayments.com/api-reference/batches/cancel-batch.md): Cancel a batch before processing begins. Valid from `uploaded`, `validating`, `validated`, `validation_failed`, or `confirmed`. Once `processing` begins, use per-payout cancellation instead.
- [Confirm a Validated Batch](https://docs.antonpayments.com/api-reference/batches/confirm-batch.md): Confirm a batch for processing. Only batches in `validated` status can be confirmed; the batch moves to `confirmed` and then `processing` as payouts are created from valid rows.
- [Download the Batch Template](https://docs.antonpayments.com/api-reference/batches/download-batch-template.md): Returns a ready-to-fill batch template with the canonical header row and a handful of example rows. Use this to anchor your batch format — column order and casing matter.
- [Retrieve a Batch](https://docs.antonpayments.com/api-reference/batches/get-batch.md): Return a single batch, including its validation summary (when available).
- [List Batch Beneficiaries](https://docs.antonpayments.com/api-reference/batches/list-batch-beneficiaries.md): List the beneficiaries that this batch created or first referenced. Covers both the auto-create path (a row with inline beneficiary details for which no matching beneficiary existed — Anton creates one and tags it with `source_batch_id`) and the match path (a row that resolved by `external_id` or di…
- [List Batch Validation Errors](https://docs.antonpayments.com/api-reference/batches/list-batch-errors.md): Return the row-level validation errors and warnings produced during the `validating` phase. Each error or warning carries the row number and field it applies to so you can point the merchant back to their source file.
- [List Payouts Created from a Batch](https://docs.antonpayments.com/api-reference/batches/list-batch-payouts.md): Cursor-paginated list of payouts created by processing this batch. Row order in the original file is preserved in the response.
- [List Per-Row Processing Results](https://docs.antonpayments.com/api-reference/batches/list-batch-results.md): Return the per-row outcome of `processing`. For each original row you get the row number, outcome (`success`, `failed`, `skipped`, `pending`), the created `payout_id` (if any), and a human-readable reason for any non-success outcome.
- [List Batches](https://docs.antonpayments.com/api-reference/batches/list-batches.md): Cursor-paginated list of batches for your merchant.
- [Upload a Batch](https://docs.antonpayments.com/api-reference/batches/upload-batch.md): Upload a batch file (CSV or XLSX) containing many payout rows. The file is stored, hashed for duplicate detection, and queued for asynchronous validation. The response returns the batch in `uploaded` status; the status transitions to `validating`, then `validated` (or `validation_failed`) via webhoo…
- [Archive a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/archive-beneficiary.md): Soft-disables a beneficiary. The record is preserved and can be restored later, but it cannot be used to initiate new payouts while archived. PII remains tokenized and accessible.
- [Create a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/create-beneficiary.md): Create a person (`individual`) or business (`business`) you want to pay. PII submitted in the request body is tokenized in Basis Theory on creation — only a display name, country, and opaque token reference are stored in the Anton database.
- [Delete a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/delete-beneficiary.md): Soft-deletes a beneficiary. The record is removed from active listings and can no longer be used to initiate new payouts. Historical payouts referencing this beneficiary remain unchanged and accessible.
- [Retrieve a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/get-beneficiary.md): Return a single beneficiary by ID. Returns `404` if the beneficiary does not exist or belongs to a different merchant.
- [Retrieve Beneficiary PII](https://docs.antonpayments.com/api-reference/beneficiaries/get-beneficiary-pii.md): Detokenizes and returns the PII stored in Basis Theory for this beneficiary. Every access is recorded in the merchant audit log (PCI DSS 10.2.1).
- [List Beneficiaries](https://docs.antonpayments.com/api-reference/beneficiaries/list-beneficiaries.md): List beneficiaries scoped to your merchant. Results are cursor-paginated and sorted by creation time descending.
- [Rescore a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/rescore-beneficiary.md): Triggers a manual Payee-pillar rescore of this beneficiary via the Anton Engine. Use this after remediating a data issue (completed verification, resolved an adverse event, updated PII) when you want a fresh verdict before the next payout rather than waiting for the next scheduled evaluation.
- [Restore a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/restore-beneficiary.md): Restores a previously archived beneficiary to active status. Beneficiaries blocked by compliance cannot be restored via this endpoint — contact support.
- [Update a Beneficiary](https://docs.antonpayments.com/api-reference/beneficiaries/update-beneficiary.md): Update mutable fields on a beneficiary: `display_name`, `country`, `external_ref`, and `metadata`. PII cannot be updated via this endpoint — use `PUT /v1/beneficiaries/{id}/pii` instead, since PII is tokenized.
- [Replace Beneficiary PII](https://docs.antonpayments.com/api-reference/beneficiaries/update-beneficiary-pii.md): Replaces the PII stored in Basis Theory for this beneficiary. The entire PII blob is replaced — partial updates are not supported, because tokens are immutable.
- [List Active Corridors](https://docs.antonpayments.com/api-reference/corridors/list-corridors.md): Return every active payout corridor on your merchant account. A corridor is a (rail_type, currency, country, method, network) combination Anton can deliver payouts through.
- [Errors](https://docs.antonpayments.com/api-reference/errors.md): A complete reference for the error envelope, HTTP status codes, and every machine-readable error code returned by the Anton Payments API.
- [Create a Lockable FX Quote](https://docs.antonpayments.com/api-reference/fx/create-fx-quote.md): Request a lockable exchange rate between two currencies. Quotes have a short expiry window; use the returned `id` on `POST /v1/fx/exchange` to lock the rate before expiry.
- [Execute an FX Exchange](https://docs.antonpayments.com/api-reference/fx/execute-fx-exchange.md): Exchange a locked quote — debits the sell currency balance and credits the buy currency balance. The quote must still be within its validity window; expired quotes return `quote_expired`.
- [Retrieve an Indicative Rate](https://docs.antonpayments.com/api-reference/fx/get-indicative-fx-rate.md): Non-binding rate between two currencies. Cheaper than a lockable quote; use for display purposes. Rate-limited to 30 per minute per IP.
- [List FX Exchanges](https://docs.antonpayments.com/api-reference/fx/list-fx-exchanges.md): Cursor-paginated history of executed FX exchanges for your merchant.
- [Idempotency](https://docs.antonpayments.com/api-reference/idempotency.md): Safely retry any mutating request without creating duplicates.
- [Create an Instrument for a Beneficiary](https://docs.antonpayments.com/api-reference/instruments/create-instrument-for-beneficiary.md): Attach a payment instrument to a beneficiary. The credentials you submit (bank account numbers, wallet addresses, card PANs) are tokenized in Basis Theory on receipt — Anton's core database stores only a token reference, a display-only masked value, and a content fingerprint used for cross-merchant…
- [Delete an Instrument](https://docs.antonpayments.com/api-reference/instruments/delete-instrument.md): Soft-delete an instrument. The instrument is removed from active listings and cannot be used on new payouts. Historical payouts referencing it remain accessible and unchanged.
- [Retrieve an Instrument](https://docs.antonpayments.com/api-reference/instruments/get-instrument.md): Return a single instrument by ID.
- [List Countries Available for Instruments](https://docs.antonpayments.com/api-reference/instruments/list-instrument-countries.md): Lightweight country list scoped to the countries Anton can deliver payouts to. Use this to populate country dropdowns in an instrument- creation form — paired with `/v1/instruments/methods` to build the full method picker.
- [List Payment-Method Schemas](https://docs.antonpayments.com/api-reference/instruments/list-instrument-methods.md): Return the per-country method catalog with the exact credential-field schema required for each method. Use this to drive dynamic instrument- creation forms that know which fields to prompt for based on the selected country and method.
- [List Instruments](https://docs.antonpayments.com/api-reference/instruments/list-instruments.md): List payment instruments across all beneficiaries in your merchant scope. Use the `beneficiary_id` filter to narrow to a single beneficiary (or call `GET /v1/beneficiaries/{id}/instruments`, which returns the same result).
- [List a Beneficiary's Instruments](https://docs.antonpayments.com/api-reference/instruments/list-instruments-for-beneficiary.md): Return all payment instruments attached to this beneficiary.
- [Update an Instrument](https://docs.antonpayments.com/api-reference/instruments/update-instrument.md): Update the mutable fields on an instrument — `label`, `is_default`, and `status`. Credentials cannot be updated; create a new instrument and delete the old one to replace them.
- [API Reference](https://docs.antonpayments.com/api-reference/introduction.md): The Anton Payments merchant API. Versioned, idempotent, cursor-paginated.
- [IP Allowlist](https://docs.antonpayments.com/api-reference/ip-allowlist.md): Anton's outbound IP addresses for firewall and security policy configuration.
- [Pagination](https://docs.antonpayments.com/api-reference/pagination.md): All list endpoints use cursor-based pagination.
- [Cancel a Payout](https://docs.antonpayments.com/api-reference/payouts/cancel-payout.md): Cancel a payout that has not yet been submitted to a rail. Cancellation is only possible from `created`, `pending_screening`, `pending_approval`, `pending_engine_review`, or `manual_review`. Once a payout reaches `processing` or beyond, it cannot be cancelled via the API — contact support if you nee…
- [Create a Payout](https://docs.antonpayments.com/api-reference/payouts/create-payout.md): Initiate a payout from your merchant balance to a beneficiary's payment instrument. The payout goes through compliance screening, velocity evaluation, and engine risk scoring before being submitted to a rail — see [How Anton Evaluates Payouts](/how-anton-evaluates-payouts) for the full lifecycle.
- [Retrieve a Payout](https://docs.antonpayments.com/api-reference/payouts/get-payout.md): Return a single payout by ID. Returns `404` if the payout does not exist or belongs to a different merchant.
- [Payout Velocity Results](https://docs.antonpayments.com/api-reference/payouts/get-payout-velocity-results.md): Returns the per-rule velocity / risk evaluation snapshot captured at payout-creation time. Each row is one rule the engine evaluated against this payout with the triggered/threshold/action values recorded for that specific evaluation — rules edited or deleted after the fact don't rewrite history her…
- [List Payout Lifecycle Events](https://docs.antonpayments.com/api-reference/payouts/list-payout-events.md): Return every status transition recorded for this payout, oldest first. Use this to reconstruct a payout's timeline for support, accounting, or debugging purposes. Note: the preferred way to react to events in real time is via webhook subscriptions — polling this endpoint wastes rate-limit budget.
- [List Payouts](https://docs.antonpayments.com/api-reference/payouts/list-payouts.md): Cursor-paginated list of payouts for your merchant, sorted by `created_at` descending.
- [Quote a Fee](https://docs.antonpayments.com/api-reference/pricing/create-pricing-quote.md): Preview the fee that would apply for a given source/destination pair and amount. Useful for surfacing fees to your end user before they confirm a payout.
- [List Merchant Pricing Plans](https://docs.antonpayments.com/api-reference/pricing/list-merchant-pricing.md): Return the pricing plans active on your merchant account. Plans are scoped by currency, country, and method — more specific plans take priority.
- [Rate Limits](https://docs.antonpayments.com/api-reference/rate-limits.md): Anton applies per-merchant and per-endpoint request ceilings. Every response carries the headers you need to stay within them.
- [List Countries](https://docs.antonpayments.com/api-reference/reference-data/list-countries.md): Return every country Anton recognizes (the full 159-country superset derived from the instrument registry), along with the currencies each country supports and whether Anton currently has an active, non-wildcard payout corridor for the destination (`payout_supported`).
- [List Currencies](https://docs.antonpayments.com/api-reference/reference-data/list-currencies.md): Return every currency Anton supports, across fiat, crypto, and stablecoin. Use these codes when building payout or FX requests.
- [List Payment Methods](https://docs.antonpayments.com/api-reference/reference-data/list-payment-methods.md): Return the catalog of payment-method descriptors — each row is a credential format (IBAN, UK bank, US bank, IPX proxies, crypto, card, mobile money) with the countries where it's supported.
- [Reset Sandbox](https://docs.antonpayments.com/api-reference/sandbox/reset-sandbox.md): Wipe sandbox data scoped to your merchant and optionally reseed. Only available in sandbox environments; returns `403 sandbox_only` elsewhere.
- [Seed Sample Beneficiaries](https://docs.antonpayments.com/api-reference/sandbox/seed-sample-beneficiaries.md): Create a curated set of sample beneficiaries across multiple countries and payment methods. Useful as CI fixtures or demo data. Sandbox only.
- [Seed Sample Payouts](https://docs.antonpayments.com/api-reference/sandbox/seed-sample-payouts.md): Create a mix of sample payouts across different statuses (pending, completed, failed, cancelled, manual_review) for UI, webhook, and integration testing. Sandbox only. Requires seeded beneficiaries — call `POST /v1/merchant/sandbox/seed-beneficiaries` first if your sandbox is empty.
- [Webhook Events](https://docs.antonpayments.com/api-reference/webhook-events.md): Every event Anton emits, grouped by resource, with payload schemas.
- [Webhook Signing](https://docs.antonpayments.com/api-reference/webhook-signing.md): Verify that every webhook delivery genuinely came from Anton.
- [Create a Webhook Subscription](https://docs.antonpayments.com/api-reference/webhooks/create-webhook-subscription.md): Register an HTTPS endpoint to receive event notifications. Anton POSTs signed JSON deliveries to the URL you supply every time an event from the `events` list fires on your merchant account.
- [Deactivate a Subscription](https://docs.antonpayments.com/api-reference/webhooks/deactivate-webhook-subscription.md): Stop delivering events to this subscription without deleting it. The subscription moves to `inactive` and stops receiving further deliveries. To re-enable a subscription later, contact support — there is no public reactivation endpoint. If you expect to re-enable an endpoint programmatically, prefer…
- [Delete a Webhook Subscription](https://docs.antonpayments.com/api-reference/webhooks/delete-webhook-subscription.md): Soft-delete a subscription. The subscription disappears from `GET /v1/webhooks` and `GET /v1/webhooks/{id}` (which will return 404) and will not receive any further event deliveries. The full delivery history is preserved for audit retention and can be retrieved via `GET /v1/webhooks/events/{id}/del…
- [Retrieve a Webhook Event](https://docs.antonpayments.com/api-reference/webhooks/get-webhook-event.md)
- [Retrieve the Signing Secret](https://docs.antonpayments.com/api-reference/webhooks/get-webhook-secret.md): Return the current HMAC signing secret for this subscription. Use this if you lost the secret after creation — the endpoint is audited and rate-limited for safety.
- [Retrieve a Webhook Subscription](https://docs.antonpayments.com/api-reference/webhooks/get-webhook-subscription.md): Retrieve a single subscription by ID. Subscriptions that have been deleted via `DELETE /v1/webhooks/{id}` are soft-deleted and return `404 webhook_subscription_not_found` here — they are not visible to merchant reads. Delivery history is still accessible via `GET /v1/webhooks/events/{id}/deliveries?…
- [List Deliveries for an Event](https://docs.antonpayments.com/api-reference/webhooks/list-webhook-deliveries.md): Return every attempt Anton made to deliver this event to every subscribed endpoint. Each attempt records the request headers, response status, body, duration, and retry schedule — useful for debugging failing integrations.
- [List Webhook Events](https://docs.antonpayments.com/api-reference/webhooks/list-webhook-events.md): Return the history of webhook events generated on your merchant account. Events persist independently of delivery — you can inspect and replay them via `/deliveries` below.
- [List Webhook Subscriptions](https://docs.antonpayments.com/api-reference/webhooks/list-webhook-subscriptions.md): Return all webhook subscriptions on your merchant account.
- [Rotate the Signing Secret](https://docs.antonpayments.com/api-reference/webhooks/rotate-webhook-secret.md): Generate a new HMAC signing secret. The raw secret is returned **exactly once** in the response body. Any subsequent `GET /v1/webhooks/{id}/secret` returns only a masked suffix (`***xxxx`). NTF-2.
- [Send a Test Delivery](https://docs.antonpayments.com/api-reference/webhooks/test-webhook-subscription.md): Dispatch a synthetic `test` event to this subscription right now. Useful for verifying signature verification, network reachability, and logging pipelines without waiting for a real event.
- [Authentication](https://docs.antonpayments.com/authentication.md): Anton authenticates programmatic API calls with OAuth 2.0 client_credentials bound to a DPoP keypair. Static API keys are not accepted on v1.
- [Changelog](https://docs.antonpayments.com/changelog.md): A record of material changes to the Anton Payments API and documentation.
- [Environments](https://docs.antonpayments.com/environments.md): Anton exposes a fully functional sandbox for development and a production environment for live money movement. The two are isolated — credentials, data, and infrastructure are separate.
- [Batch Payouts](https://docs.antonpayments.com/guides/batch-payouts.md): Upload a CSV or XLSX of many payouts in a single call. Anton validates, you confirm, Anton processes.
- [Crypto & Stablecoin Payouts](https://docs.antonpayments.com/guides/crypto-payouts.md): Pay beneficiaries on-chain or in stablecoins. The API surface is identical to fiat — the differences are in the instrument, the finality model, and the network details.
- [FX & Currency Exchange](https://docs.antonpayments.com/guides/fx-exchange.md): Get indicative rates, lock a quote, execute an exchange between currencies — and understand how cross-currency payouts use all three.
- [Going Live](https://docs.antonpayments.com/guides/going-live.md): The checklist you walk through before your first production payout. Every item is a hard dependency — sandbox cannot prove any of it for you.
- [Handle Webhooks](https://docs.antonpayments.com/guides/handle-webhooks.md): Subscribe to events, verify signatures, and build a webhook consumer you can rely on.
- [Manage Beneficiaries](https://docs.antonpayments.com/guides/manage-beneficiaries.md): Create, update, search, archive, and delete the people and businesses you pay.
- [Send a Payout](https://docs.antonpayments.com/guides/send-a-payout.md): The full payout flow — beneficiary, instrument, economics, corridors, and the state machine your integration should respond to.
- [How Anton Evaluates Payouts](https://docs.antonpayments.com/how-anton-evaluates-payouts.md): Every payout moves through sanctions screening, velocity control, and AI risk scoring before a single dollar leaves your balance. Here's what happens — and how your integration should respond.
- [Anton Payments](https://docs.antonpayments.com/introduction.md): AI-native cross-border payout infrastructure. Fiat, stablecoin, and crypto, routed across a global network of rails.
- [Quickstart](https://docs.antonpayments.com/quickstart.md): Send your first payout in five minutes. You'll create a beneficiary, attach a payment instrument, and fire a sandbox payout end to end.
- [Sandbox Overview](https://docs.antonpayments.com/sandbox/overview.md): A full-fidelity environment for building and testing your Anton integration. Real API surface, no real money.
- [Sandbox Test Data](https://docs.antonpayments.com/sandbox/test-data.md): Reset your sandbox to a clean state and seed realistic beneficiaries, instruments, and payouts with a single call each.

## OpenAPI Specs

- [openapi-merchant](https://docs.antonpayments.com/openapi-merchant.yaml)
- [openapi](https://docs.antonpayments.com/api-reference/openapi.json)

## Optional

- [API Status](https://status.antonpayments.com)
- [Support](https://help.antonpayments.com)