# Circle Docs: API reference Mint

> Developer documentation for Circle's developer tools

> ## Agent Instructions
> Before reading these docs, install the relevant Circle Skill to get pre-loaded context — skills are LLM-optimized and cover architecture decisions, correct flows, and common pitfalls. In Claude Code: run /plugin marketplace add circlefin/skills then /plugin install circle-skills@circle. With Vercel Skills CLI: run npx skills add circlefin/skills. Available skills: use-usdc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-usdc/SKILL.md (balances, transfers, approvals on EVM and Solana); EURC has no skill — see https://developers.circle.com/stablecoins/what-is-eurc.md; bridge-stablecoin https://github.com/circlefin/skills/blob/master/plugins/circle/skills/bridge-stablecoin/SKILL.md (crosschain transfers via CCTP, USDC, EURC, and third-party assets); use-arc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-arc/SKILL.md (Arc chain config, contract deployment, USDC bridging — Arc docs: https://docs.arc.io/llms.txt); use-circle-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-circle-wallets/SKILL.md (choose wallet type); use-developer-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-developer-controlled-wallets/SKILL.md (custodial wallets for payouts and treasury); use-user-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-user-controlled-wallets/SKILL.md (embedded wallets with Web2 login); use-modular-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-modular-wallets/SKILL.md (smart contract wallets with passkeys and ERC-4337); use-gateway https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-gateway/SKILL.md (unified USDC balance, nanopayments); use-smart-contract-platform https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-smart-contract-platform/SKILL.md (deploy, interact, monitor contracts). Pair any skill with the Circle MCP server for live SDK signatures, contract addresses, and chain IDs: {"mcpServers":{"circle":{"url":"https://api.circle.com/v1/codegen/mcp"}}}.
> Read the product overview first. Each product has an overview explaining when and why to use it. Read it before quickstarts.
> Pick the right wallet type. Developer-controlled (you hold keys), user-controlled (end user holds keys via PIN/social login), or modular (smart contract wallets with passkeys). See https://developers.circle.com/wallets.md.
> Use CCTP V2 for crosschain transfers. CCTP natively transfers USDC and EURC via burn-and-mint, and supports permissionless wrapping of third-party assets via lock-and-mint. V1 is legacy; always use V2 unless V1 is specified or the chain requires it (Noble, Sui, and Aptos still require V1). Migration guide: https://developers.circle.com/cctp/migration-from-v1-to-v2.md.
> Use Bridge Kit for frontend bridging. Wraps CCTP with a simpler SDK for user-facing apps. Use CCTP directly for backend transfers.
> Gas Station vs Paymaster. Gas Station sponsors gas for Circle Wallet transactions. Paymaster lets users pay gas in USDC. Different use cases — read both overviews.
> Gateway Nanopayments for sub-cent payments. Gasless USDC micropayments down to $0.000001 via x402 and batched settlement. For pay-per-request APIs, AI agent payments, streaming.
> Look up USDC addresses per chain. Never hardcode — use https://developers.circle.com/stablecoins/usdc-contract-addresses.md.
> Prefer SDKs over raw API calls. Node.js and Python SDKs handle auth, retries, and errors.
> API key required. Bearer token in Authorization header. Testnet and mainnet use separate keys and may use different base URLs depending on the product.
> Set up webhooks when available. Most operations are async. Webhooks deliver transaction confirmations and state changes.
> When calling list endpoints, paginate using pageSize and pageAfter until no nextPageAfter cursor is returned—stopping at the first page silently misses records.
> Building an AI agent? Start with the Agent Stack—Circle CLI, agent wallets, and nanopayments built for autonomous use cases: https://developers.circle.com/agent-stack.md.

## Mint

- [Circle Mint API](https://developers.circle.com/api-reference/circle-mint.md): Manage USDC and EURC balances, process crypto deposits and payouts, execute cross-currency trades, and manage reserves.
- [Postman collection](https://developers.circle.com/api-reference/circle-mint/postman.md): Use Circle's Postman collection to send API requests and explore the Circle Mint APIs.
- [Error codes](https://developers.circle.com/api-reference/circle-mint/error-codes.md): Reference for synchronous and asynchronous error codes returned by the Circle Mint API, organized by product, with recommended treatment for each.

### Core API

#### Balances

- [List all balances](https://developers.circle.com/api-reference/circle-mint/account/list-business-balances.md): Retrieves the balance of funds that are available for use.

#### Payouts

- [List all payouts](https://developers.circle.com/api-reference/circle-mint/account/list-business-payouts.md): Lists all payouts for your account.
- [Create a payout](https://developers.circle.com/api-reference/circle-mint/account/create-business-payout.md): Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency.
- [Get a payout](https://developers.circle.com/api-reference/circle-mint/account/get-business-payout.md)
- [List burn fee calculations](https://developers.circle.com/api-reference/circle-mint/account/list-net-burn-fee-daily-calculations.md): Returns burn fee calculations, including daily records and surcharges. Returns up to 50 calculations in descending chronological order, or `pageSize` results if specified.

#### Wires

- [List all wire bank accounts](https://developers.circle.com/api-reference/circle-mint/account/list-business-wire-accounts.md)
- [Create a wire bank account](https://developers.circle.com/api-reference/circle-mint/account/create-business-wire-account.md)
- [Get a wire bank account](https://developers.circle.com/api-reference/circle-mint/account/get-business-wire-account.md)
- [Get wire instructions](https://developers.circle.com/api-reference/circle-mint/account/get-business-wire-account-instructions.md): Get the wire transfer instructions into the Circle bank account given your bank account ID.

#### Payments

- [Create a mock Wire payment](https://developers.circle.com/api-reference/circle-mint/account/create-mock-wire-payment.md): In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet.

#### CUBIX

- [List all CUBIX bank accounts.](https://developers.circle.com/api-reference/circle-mint/account/list-business-cubix-accounts.md)
- [Create a CUBIX bank account](https://developers.circle.com/api-reference/circle-mint/account/create-business-cubix-account.md)
- [Get a CUBIX bank account](https://developers.circle.com/api-reference/circle-mint/account/get-business-cubix-account.md)
- [Get CUBIX instructions](https://developers.circle.com/api-reference/circle-mint/account/get-business-cubix-account-instructions.md): Get the CUBIX transfer instructions into the Circle bank account given your fiat account id.

#### Transfers

- [List all transfers](https://developers.circle.com/api-reference/circle-mint/account/list-business-transfers.md): Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided.
- [Create a transfer](https://developers.circle.com/api-reference/circle-mint/account/create-business-transfer.md): A transfer can be made from an existing business account to a blockchain location.
- [Get a transfer](https://developers.circle.com/api-reference/circle-mint/account/get-business-transfer.md)
- [Get associated accounts](https://developers.circle.com/api-reference/circle-mint/account/get-associated-accounts.md): Returns a list of sibling CMAs that are associated with the current account under unified credentials. These accounts can be used as destinations for cross-entity transfers.

#### Addresses

- [List all deposit addresses](https://developers.circle.com/api-reference/circle-mint/account/get-business-deposit-address.md): Returns a list of deposit addresses for a given wallet.
- [Create a deposit address](https://developers.circle.com/api-reference/circle-mint/account/create-business-deposit-address.md): Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryp…
- [List all recipient addresses](https://developers.circle.com/api-reference/circle-mint/account/list-business-recipient-addresses.md): Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.
- [Create a recipient address](https://developers.circle.com/api-reference/circle-mint/account/create-business-recipient-address.md): Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
- [Delete a recipient address](https://developers.circle.com/api-reference/circle-mint/account/delete-business-recipient-address.md): Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.
- [List recipient VASPs](https://developers.circle.com/api-reference/circle-mint/account/list-business-recipient-vasps.md): Returns the Virtual Asset Service Providers (VASPs) available to the caller. Use a returned `id` as `vaspId` in `ownership.custody` when creating a recipient and custody is `hosted`.

#### Deposits

- [List fiat deposits](https://developers.circle.com/api-reference/circle-mint/account/list-business-deposits.md): Searches for wire and other fiat deposits sent to your business account. Onchain (crypto) deposits do not appear on this endpoint; use `GET /v1/transfers` to retrieve onchain deposits. If the date parameters are omitted, the endpoint returns the most recent deposits. It returns up to 50 deposits in…
- [Get a deposit by ID](https://developers.circle.com/api-reference/circle-mint/account/get-business-deposit-by-id.md): Returns a deposit by ID.

#### PIX

- [List all PIX bank accounts.](https://developers.circle.com/api-reference/circle-mint/account/list-business-pix-accounts.md)
- [Create a PIX bank account](https://developers.circle.com/api-reference/circle-mint/account/create-business-pix-account.md)
- [Get a PIX bank account](https://developers.circle.com/api-reference/circle-mint/account/get-business-pix-account.md)
- [Get PIX instructions](https://developers.circle.com/api-reference/circle-mint/account/get-business-pix-account-instructions.md): Get the PIX transfer instructions into the Circle bank account given your bank account id.

#### Reporting

- [List reports](https://developers.circle.com/api-reference/circle-mint/account/list-reports.md): Returns a paginated list of the account's previously generated reports for a given report type and date range, each with a pre-signed `downloadUrl`. Listable report types: `managed_payout_transactions`, `managed_payment_wallet_balances`, `managed_payin_transactions`, `camt_managed`, `camt053`, `camt…
- [Request a report](https://developers.circle.com/api-reference/circle-mint/account/request-report.md): Submits a report generation request. `reportType` specifies the type of report and required fields. Supported report types: `camt053`, `camt_managed`, `managed_payout_transactions`, `managed_payment_wallet_balances`, and `managed_payin_transactions`. The managed-payment reports take a `timeframe` fi…
- [Get report by ID](https://developers.circle.com/api-reference/circle-mint/account/get-report-by-id.md): Returns the current metadata for a report, including a fresh pre-signed `downloadUrl` when the report is `ready`. Use this endpoint to check the status of a `pending` report or to obtain a new download URL after the previous one has expired.
- [Download report content](https://developers.circle.com/api-reference/circle-mint/account/get-report-content.md): Streams the raw report content as a file download, an alternative to following `downloadUrl` from the JSON response. Returns `409` if the report is not yet `ready`.

#### Settlement Bank Routing

- [Get wire routing info](https://developers.circle.com/api-reference/circle-mint/account/get-wire-routing-info.md): Retrieves available settlement banks and current routing configuration for a wire fiat account.
- [Update wire routing preferences](https://developers.circle.com/api-reference/circle-mint/account/update-wire-routing-preferences.md): Creates or updates the settlement bank routing preferences for a wire fiat account.
- [Get PIX routing info](https://developers.circle.com/api-reference/circle-mint/account/get-pix-routing-info.md): Retrieves available settlement banks and current routing configuration for a PIX fiat account.
- [Update PIX routing preferences](https://developers.circle.com/api-reference/circle-mint/account/update-pix-routing-preferences.md): Creates or updates the settlement bank routing preferences for a PIX fiat account.

### API overview

#### Health

- [Ping](https://developers.circle.com/api-reference/circle-mint/general/ping.md): Checks that the service is running.

#### Management

- [Get configuration info](https://developers.circle.com/api-reference/circle-mint/general/get-account-config.md): Retrieves general configuration information.

#### Subscriptions

- [List all notification subscriptions](https://developers.circle.com/api-reference/circle-mint/general/list-subscriptions.md): Retrieve a list of existing notification subscriptions with details.
- [Create a notification subscription](https://developers.circle.com/api-reference/circle-mint/general/create-subscription.md): Subscribe to receiving notifications at a given endpoint. The endpoint should be able to handle AWS SNS subscription requests. For more details see https://docs.aws.amazon.com/mobile/sdkforxamarin/developerguide/sns-send-http.html. Note, the sandbox environment allows a maximum of 3 active subscript…
- [Remove a notification subscription](https://developers.circle.com/api-reference/circle-mint/general/delete-subscription.md): To remove a subscription, all its subscription requests' statuses must be either 'confirmed', 'deleted' or a combination of those. A subscription with at least one 'pending' subscription request cannot be removed.

#### Stablecoins

- [List all stablecoins](https://developers.circle.com/api-reference/circle-mint/general/list-stablecoins.md): Retrieves total circulating supply for supported stablecoins across all chains. This endpoint is rate limited to one call per minute (based on IP).

### Core API for institutions

#### External Entities

- [Get all external entities](https://developers.circle.com/api-reference/circle-mint/institutional/get-all-external-entities.md): Returns all external entities for the institutional account.
- [Create an external entity](https://developers.circle.com/api-reference/circle-mint/institutional/create-external-entity.md): Creates an external entity for the institutional account.
- [Get an external entity by wallet ID](https://developers.circle.com/api-reference/circle-mint/institutional/get-external-entity-by-wallet-id.md): Returns an external entity by wallet ID.

### Cross-currency API

#### Trades

- [Get quote](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-quote.md): Fetches an indicative exchange rate between two currencies. Exactly one of the from and to currencies must be USDC; the other may be EURC or a supported fiat currency (MXN, SGD, BRL, HKD), subject to your account's enabled currencies. Note: The current market exchange rate will be applied when Circl…
- [Get all FX trades](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-fx-trades.md): Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement.
- [Create FX trade](https://developers.circle.com/api-reference/circle-mint/cross-currency/create-fx-trade.md): Creates a cross-currency trade
- [Get FX trade](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-fx-trade-id.md): Returns an FX trade by ID.
- [Create FX account](https://developers.circle.com/api-reference/circle-mint/cross-currency/create-fx-account.md): Creates a currency trading account
- [Get daily currency exchange limits](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-daily-fx-limits.md): Returns daily currency exchange limits and usages.

#### Settlements

- [Get all settlements](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-settlements.md): Returns all settlements.
- [Get settlement](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-settlement-id.md): Returns a settlement by ID.
- [Get settlement instructions](https://developers.circle.com/api-reference/circle-mint/cross-currency/get-settlement-instructions.md): Returns settlement instructions for a specific currency.

#### Payments

- [Create a mock PIX payment](https://developers.circle.com/api-reference/circle-mint/cross-currency/create-mock-pix-payment.md): Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet.

### Reserve management API

#### Reserve Management

- [Create daily custody balance report](https://developers.circle.com/api-reference/circle-mint/reserve-management/report-daily-custody-balances.md): Creates a daily custody balance report for USDC and EURC and sends it to Circle.

### Credit API

#### Credit

- [Get credit line details](https://developers.circle.com/api-reference/circle-mint/credit/get-credit-line.md): Provides overall credit line details, including status, available limit, and outstanding balance.

#### Credit Repayments

- [Get repayment account details](https://developers.circle.com/api-reference/circle-mint/credit/get-repayment-account-detail.md): Returns repayment account details and wire instructions for making a credit repayment using the specified fiat account.
- [List all credit repayments](https://developers.circle.com/api-reference/circle-mint/credit/list-credit-repayments.md): Returns a paginated list of all repayments (fiat and crypto). Filterable by create date range, transfer ID, type, and status.
- [Get a credit repayment](https://developers.circle.com/api-reference/circle-mint/credit/get-credit-repayment.md): Returns detailed information about a specific repayment.
- [Initiate a crypto repayment](https://developers.circle.com/api-reference/circle-mint/credit/create-credit-crypto-repayment.md): Initiates a crypto repayment for a credit transfer.
- [Create a mock wire repayment](https://developers.circle.com/api-reference/circle-mint/credit/create-mock-wire-repayment.md): In the sandbox environment, initiate a mock wire repayment that simulates an incoming wire payment to repay an outstanding credit transfer. The fiat account will be automatically linked as a repayment account if not already linked.

#### Credit Transfers

- [List all credit transfers](https://developers.circle.com/api-reference/circle-mint/credit/list-credit-transfers.md): Returns a paginated list of all credit transfers. Filterable by create date range and status. Transfer items in list responses do not include outstanding and fees properties.
- [Create a credit transfer](https://developers.circle.com/api-reference/circle-mint/credit/create-credit-transfer.md): Requests a new credit transfer (drawdown) from the credit line. Disbursement is asynchronous.
- [Get a credit transfer](https://developers.circle.com/api-reference/circle-mint/credit/get-credit-transfer.md): Returns detailed information about a specific credit transfer.
- [Reserve funds for a credit transfer](https://developers.circle.com/api-reference/circle-mint/credit/reserve-credit-transfer-funds.md): Reserves funds for a Settlement Advance draw. This is the first mandatory step in the Settlement Advance transfer flow.
- [Request reserved funds](https://developers.circle.com/api-reference/circle-mint/credit/request-credit-transfer-reserved-funds.md): Transitions a `funds_reserved` transfer to `requested` status by uploading evidence (wire proof). This initiates the manual approval process for Settlement Advance transfers.
- [Cancel reserved funds](https://developers.circle.com/api-reference/circle-mint/credit/cancel-credit-transfer-reserve.md): Cancels a `funds_reserved` transfer and releases the reserved amount back to available credit.

#### Credit Fees

- [List all credit fees](https://developers.circle.com/api-reference/circle-mint/credit/list-credit-fees.md): Returns a paginated list of all historical fees. Filterable by create date range, currency, and status.
- [Get a credit fee](https://developers.circle.com/api-reference/circle-mint/credit/get-credit-fee.md): Returns detailed information about a specific fee.

### Digital Asset-Backed Borrowing

#### Borrow Wallets

- [Get the wallet](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-wallets.md): Returns the wallet as a single-element array.
- [Create a wallet](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-wallet.md): Provisions your wallet. The wallet is co-owned by your passkey (supplied as `ownerKey` + `credentialId`) and a Circle-provisioned ECDSA key. Circle derives the MSCA address and signs the setup UserOperation for you.
- [Add a wallet owner](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/add-borrow-wallet-owner.md): Adds a new passkey owner to your wallet. Asynchronous. Circle builds, signs, and submits the UserOperation for you. Returns an `onchainJob` of `jobType = add_owner`. Poll the job until it reaches `completed`.

#### Borrow Loans

- [List all loans](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-loans.md): Returns a paginated list of loans you own, sorted by `createDate`, most recent first.
- [Create a loan (borrow)](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-loan.md): Originates a loan (borrow) against posted collateral. Asynchronous. Circle builds, signs, and submits the borrow UserOperation for you. Poll the returned job until it reaches `completed` or a terminal failure state.
- [Get a loan](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/get-borrow-loan.md): Returns detailed information about a specific loan position.
- [Create a repayment](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-repayment.md): Repays part or all of a loan. Asynchronous. Circle builds, signs, and submits the UserOperation for you.
- [Add collateral](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/add-borrow-loan-collateral.md): Adds collateral to an existing loan, typically in response to a margin call. Asynchronous. Circle builds, signs, and submits the UserOperation for you.
- [Trigger a residual collateral sweep](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-loan-residual-sweep.md): Triggers a sweep of collateral left in the lending protocol after a partial liquidation. Circle creates this job automatically when it detects the residual, so you only need to call this endpoint to manually retry the sweep.

#### Borrow Jobs

- [List all jobs](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-jobs.md): Returns a paginated list of onchain jobs available to you, sorted by `createDate`, most recent first. Useful for rendering transaction history and surfacing jobs that require customer action, such as automatically created `withdraw_residual` jobs.
- [Get a job](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/get-borrow-job.md): Returns details for a single onchain job, including `jobType`, `amount`, `asset`, `toAddress`, `loanId`, and timeline timestamps for displaying the transaction to an end user.

#### Borrow Markets

- [List all markets](https://developers.circle.com/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-markets.md): Returns the allowlisted lending markets available to you, including current rates and LTV parameters.

### Partner Onboarding API

#### Partner Applications

- [List applications for the authenticated partner](https://developers.circle.com/api-reference/circle-mint/onboarding/list-applications.md)
- [Retrieve an application by ID](https://developers.circle.com/api-reference/circle-mint/onboarding/get-application.md)
- [Cancel an application](https://developers.circle.com/api-reference/circle-mint/onboarding/cancel-application.md): Cancels a draft ONBOARDING_APPLICATION. Other operation types are not currently cancellable.
- [List active certifications for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/get-certifications.md): Returns the active certifications the end user must agree to for this application, including the HTML content, certification id, and metadata. Pass the returned ids back on POST /{applicationId}/submit as certificationIds to explicitly acknowledge them, or omit certificationIds to let the service au…
- [Retrieve data for all visible sections](https://developers.circle.com/api-reference/circle-mint/onboarding/bulk-get-data.md): Returns all visible section data keyed by section name alongside section statuses. The data object is round-trip compatible with PATCH /{applicationId}/data. Sections that do not contribute to application progress are excluded.
- [Save data for multiple sections in a single request](https://developers.circle.com/api-reference/circle-mint/onboarding/bulk-save.md): Accepts a JSON object keyed by section name. Each value is the same payload shape as PUT /sections/{sectionName}. Validation is atomic: all sections are validated before any data is saved, and if any section fails validation the entire request is rejected. Saves are sequential: after validation pass…
- [Get the JSON Schema (draft 2020-12) for an application's template](https://developers.circle.com/api-reference/circle-mint/onboarding/get-application-schema.md)
- [Submit an application](https://developers.circle.com/api-reference/circle-mint/onboarding/submit-application.md)

#### Partner Documents

- [List documents for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/list-documents.md)
- [Upload a document for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/upload-document.md)
- [Download a document](https://developers.circle.com/api-reference/circle-mint/onboarding/download-document.md)
- [Delete a document](https://developers.circle.com/api-reference/circle-mint/onboarding/delete-document.md)

#### Partner RFIs

- [List RFI bundles for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/list-rfis.md)
- [Get RFI detail with comment history](https://developers.circle.com/api-reference/circle-mint/onboarding/get-rfi.md)
- [Submit field data in response to an UPDATE_FIELD or NEW_FIELD RFI](https://developers.circle.com/api-reference/circle-mint/onboarding/update-rfidata.md)
- [Add a comment to an RFI](https://developers.circle.com/api-reference/circle-mint/onboarding/create-comment.md)
- [Update a comment on an RFI](https://developers.circle.com/api-reference/circle-mint/onboarding/update-comment.md)
- [Delete a comment on an RFI](https://developers.circle.com/api-reference/circle-mint/onboarding/delete-comment.md)

#### Partner Sections

- [List sections for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/list-sections.md): Returns visible sections with statuses. When includeData=true, each entry also includes the section's current field data — useful for rendering a progress view alongside prefilled form data. When typedValues=true (only meaningful with includeData=true), array/object/number field values are emitted a…
- [Retrieve section data for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/get-section.md): Returns field data for the specified section. When typedValues=true, array/object/number field values are emitted as native JSON nodes instead of strings.
- [Save section data for an application](https://developers.circle.com/api-reference/circle-mint/onboarding/save-section.md): Saves field data for a section. The request body is a JSON object whose shape is defined by the section's JSON Schema (retrieve it via GET /{applicationId}/schema). For MULTIPLE array sections, maxItems is enforced and over-limit payloads return 422.
- [Remove an entity from an array section](https://developers.circle.com/api-reference/circle-mint/onboarding/remove-entity.md)

### Crypto deposits API

#### Payments

- [List all payments](https://developers.circle.com/api-reference/circle-mint/payments/list-payments.md)
- [Get a payment](https://developers.circle.com/api-reference/circle-mint/payments/get-payment.md)

#### Crypto Payment Intents

- [List all payment intents](https://developers.circle.com/api-reference/circle-mint/payments/list-payment-intents.md)
- [Create a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-intent.md): Create a continuous (default) or transient payment intent. Continuous payment intents are created by default. To create a transient payment intent, the `type` field must be explicitly set to `transient`.
- [Get a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/get-payment-intent.md)
- [Expire a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/expire-payment-intent.md)
- [Refund a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/refund-payment-intent.md)

#### Crypto Payment Customers

- [List crypto payment customers](https://developers.circle.com/api-reference/circle-mint/payments/list-payment-customers.md): Lists Travel Rule customers for eligible Circle Singapore (`CIRCLE_SG`) merchants. List responses omit customer PII.
- [Create a crypto payment customer](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-customer.md): Creates a Travel Rule customer profile for crypto payment attribution. These APIs are available to eligible Circle Singapore (`CIRCLE_SG`) merchants.
- [Get a crypto payment customer](https://developers.circle.com/api-reference/circle-mint/payments/get-payment-customer.md): Returns a Travel Rule customer, including customer details, for eligible Circle Singapore (`CIRCLE_SG`) merchants.
- [List crypto payment customer wallets](https://developers.circle.com/api-reference/circle-mint/payments/list-payment-customer-wallets.md)
- [Create a crypto payment customer wallet](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-customer-wallet.md): Registers a hosted customer wallet for an approved Travel Rule customer. The resulting customer wallet ID can be supplied as `customerWalletId` when creating a transient payment intent.
- [Get a crypto payment customer wallet](https://developers.circle.com/api-reference/circle-mint/payments/get-payment-customer-wallet.md)

#### Crypto Payment Refund Addresses

- [Create a crypto payment refund address](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-refund-address.md): Creates a refund address-book entry that can be used as `destination.addressBookId` when refunding a crypto payment intent.

### Crypto payouts API

#### Payouts

- [List all payouts](https://developers.circle.com/api-reference/circle-mint/payouts/list-payouts.md)
- [Create a payout](https://developers.circle.com/api-reference/circle-mint/payouts/create-payout.md): Create a stablecoin payout.
- [Get a payout](https://developers.circle.com/api-reference/circle-mint/payouts/get-payout.md)
- [Get a payout RFI](https://developers.circle.com/api-reference/circle-mint/payouts/get-payout-rfi.md): Retrieves the active Request for Information (RFI) for the specified fiat payout. An RFI is issued when the compliance team requires additional information before the payout can proceed. Check the `fieldRequirements.schema` to determine which fields must be submitted via `POST /v1/payouts/{id}/rfi/s…
- [Submit a payout RFI response](https://developers.circle.com/api-reference/circle-mint/payouts/submit-payout-rfi.md): Submits the information requested by an active RFI for the specified fiat payout. Use `GET /v1/payouts/{id}/rfi` first to retrieve the `fieldRequirements.schema`, which defines the required keys and their validation rules.
- [Upload a payout RFI file](https://developers.circle.com/api-reference/circle-mint/payouts/upload-payout-rfi-files.md): Uploads a file in response to an active RFI file requirement for the specified fiat payout.

#### Crypto Address Book

- [List all recipients](https://developers.circle.com/api-reference/circle-mint/payouts/list-address-book-recipients.md)
- [Create a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/create-address-book-recipient.md): Creates an address book recipient. Required fields depend on your Circle entity; use the request body options that match your integration.
- [Get a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/get-address-book-recipient.md)
- [Modify a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/modify-address-book-recipient.md): Updates address book recipient metadata.
- [Delete a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/delete-address-book-recipient.md)
- [Cancel recipient verification](https://developers.circle.com/api-reference/circle-mint/payouts/cancel-address-book-recipient-verification.md): Cancels the pending verification session for a self-hosted wallet address book recipient.
- [Resend recipient verification email](https://developers.circle.com/api-reference/circle-mint/payouts/resend-address-book-recipient-verification.md): Resends the verification email for a self-hosted wallet address book recipient.
- [List VASPs](https://developers.circle.com/api-reference/circle-mint/payouts/list-address-book-vasps.md): Returns active Virtual Asset Service Providers (VASPs) available for the customer's jurisdiction. Use returned `id` values as `vaspId` in `ownership.custody` when creating a recipient and custody is `hosted`.

## OpenAPI Specs

- [account](/openapi/account.yaml)
- [general](/openapi/general.yaml)
- [institutional](/openapi/institutional.yaml)
- [cross-currency](/openapi/cross-currency.yaml)
- [reserve-management](/openapi/reserve-management.yaml)
- [credit](/openapi/credit.yaml)
- [digital-asset-backed-borrowing](/openapi/digital-asset-backed-borrowing.yaml)
- [partner-openapi](/openapi/partner-openapi.yaml)
- [payments](/openapi/payments.yaml)
- [payouts](/openapi/payouts.yaml)