Circle MCP connector

• List List all Circle entity monitored tokens List monitored tokens in Circle, optionally filtered by blockchain, token address, or token symbol. Returns: id.
• Create Create a Circle entity monitored token Add a new token to Circle's monitored token list. Returns the monitored token object including id, blockchain, tokenAddress, and tokenSymbol. A 200 response indicates the token was already present (no update); a 201 indicates it was newly added. Required: blockchain, tokenAddress.
• Update Circle entity monitored tokens bulk update Upsert the monitored token list for the Circle entity, adding or updating tokens to monitor across blockchains. Returns the updated monitored tokens including token items with their blockchain, token address, and token symbol. Required: tokenItems.
• Update Circle monitored tokens scopes bulk update Update the monitored tokens scope in Circle to select between monitoring all tokens or only selected tokens from the monitored tokens list. Returns an empty 200 response on success. Requires a request body specifying the desired monitoring scope.
• Delete Delete a Circle monitored tokens delete by ID Delete tokens from the monitored token list in Circle. Returns an empty response on success. Requires a request body identifying the tokens to remove.
• List List all Circle entity public keys Get the public key associated with the entity in Circle's Web3 Services. Returns: data. No caller-supplied parameters required.
• List List all Circle config entities Get the configuration for the entity in Circle. Returns the app ID associated to the entity. Returns: appId.
• Create Create a Circle faucet drip Request testnet tokens for your wallet in Circle. Returns an empty 204 response on success. Requires upgrading to mainnet before this endpoint can be called.
• List List all Circle pings Ping the Circle API to check that the service is running. Returns a simple health-check confirmation response.
• List List all Circle notifications subscriptions List all notification subscriptions in Circle. Returns: id, name, endpoint, enabled, createDate, updateDate, notificationTypes, restricted.
• Create Create a Circle notifications subscription Create a notification subscription in Circle by configuring an endpoint to receive webhook notifications. Returns: id, name, endpoint, enabled, createDate, updateDate, notificationTypes, restricted. Required: endpoint, name, enabled, notificationTypes. CPN requires name and enabled in addition to endpoint and notificationTypes.
• Get Get single Circle notifications subscription by ID Get a single notification subscription in Circle by id. Returns: id. Required: id.
• Update Update a Circle notifications subscription by ID Update a notification subscription in Circle by id, modifying the endpoint and notification settings. Returns: id, createDate. Required: id.
• Delete Delete a Circle notifications subscription by ID Delete a notification subscription in Circle by id. Returns an empty 204 response on success. Required: id.
• Get Get single Circle notifications public key by ID Get a Circle notification signature public key by id. The returned key and algorithm are used to verify digital signatures on webhook notifications, ensuring they came from Circle. Returns: id, algorithm, publicKey, createDate. Required: id.
• List List all Circle w 3 s wallet sets List all wallet sets in Circle. Returns each wallet set with its id, name, custodyType, createDate, and updateDate.
• Get Get single Circle w 3 s wallet set by ID Get a Circle wallet set by id. Returns: id. Required: id.
• Create Create a Circle developer wallet set Create a new developer-controlled wallet set in Circle. Returns the created wallet set object including id, name, and custodyType. A developer account can create up to 1,000 wallet sets, with each set supporting up to 10 million wallets.
• Update Update a Circle developer wallet set by ID Update the name of a developer-controlled wallet set in Circle. Returns the updated wallet set object including its id, name, custodyType, createDate, and updateDate. Required: id.
• Create Create a Circle developer wallet Create developer-controlled wallets in Circle within a wallet set for specified blockchains. Returns the created wallet objects including id, address, blockchain, state, walletSetId, and accountType. Required: walletSetId, blockchains, idempotencyKey. Each walletSetId supports a maximum of 10 million wallets.
• List List all Circle w 3 s wallets List Circle W3S wallets filtered by address, blockchain, wallet set, SCA core, or reference ID. Returns: id.
• Get Get single Circle w 3 s wallet by ID Retrieve an existing wallet in Circle by its id. Returns the wallet object including id, walletSetId, blockchain, address, state, accountType, createDate, and updateDate. Required: id.
• Update Update a Circle w 3 s wallet by ID Update the info metadata of a Circle wallet by id. Returns the updated wallet object including id, address, blockchain, walletSetId, custodyType, and metadata. Required: id. Frozen wallets cannot be updated.
• List List all Circle wallets balances List developer-controlled wallets with balances in Circle, filtered by blockchain and optional criteria. Returns: id. Required: blockchain. On Aptos, only primary storage token balances are returned; secondary storage tokens are excluded.
• Update Circle wallets derives bulk update Derive a developer-controlled wallet on a target blockchain by reusing the address of an existing source wallet in Circle. If the target wallet already exists, its metadata is updated instead. Returns the wallet object including id, address, blockchain, and walletSetId. Required: source blockchain, wallet address, and target blockchain.
• Create Create a Circle sign message Sign a message from a developer-controlled wallet in Circle. Supports EIP-191 for Ethereum-based chains and Ed25519 for Solana and Aptos. Returns: id. Required: id, message. Provide either walletId or both walletAddress and blockchain to identify the wallet.
• Create Create a Circle sign typed data Generate a challenge for signing EIP-712 typed structured data from a user-controlled wallet in Circle. Returns: id. Identify the wallet by providing either walletId, or both walletAddress and blockchain. Only supports Ethereum and EVM-compatible blockchains.
• Create Create a Circle sign transaction Create a challenge to sign a transaction from a user-controlled wallet in Circle. Returns the challenge including challengeId and challenge content for the user to approve via the Circle SDK. Required: walletId or both walletAddress and blockchain. Only supports SOL, SOL-DEVNET, EVM, and EVM-TESTNET chains.
• Create Create a Circle sign delegate action Sign a delegate action from a specific developer-controlled wallet in Circle. Returns: signature. Required: delegateAction, plus either walletId or both walletAddress and blockchain. Only available for NEAR and NEAR-TESTNET blockchains.
• List List all Circle w 3 s transactions List all transactions in Circle Programmable Wallets. Returns transaction details including id, state, transaction type, blockchain, source/destination addresses, and transaction hash. Supports optional filters by blockchain, custody type, destination address, transaction state, transaction hash, transaction type, wallet IDs, reference ID, developer operation, and date range.
• List List all Circle transactions lowest nonce transactions Get the lowest nonce pending transaction for a wallet in Circle, searching transactions in QUEUED, SENT, or STUCK state. Returns: id, state, nonce, blockchain, walletId, txHash, sourceAddress, destinationAddress. Required: either walletId, or both walletAddress and blockchain. Returns 204 when no matching transaction is found.
• List List all Circle transactions fee parameters Get the latest blockchain fee parameters from Circle with an optional account type filter. Returns: gasPrice, maxFee, priorityFee. Required: blockchain. Account type defaults to EOA.
• Update Circle wallet blockchains bulk update Derive or update a developer-controlled wallet on a target EVM blockchain in Circle, using the address of an existing source wallet. If the target wallet already exists, its metadata is updated. Returns: id, createDate, data. Required: wallet_id, blockchain. Only supported for EVM-based blockchains.
• Get Get single Circle w 3 s token by ID Get details of a specific token in Circle by its unique UUID identifier. Returns the token object including its id. Required: id.
• List List all Circle wallet nfts List NFTs stored in a Circle developer-controlled wallet by wallet ID. Returns NFT records including token name, token address, and token standard. Required: wallet_id.
• Create Create a Circle transactions validate addrese Validate a blockchain address in Circle, confirming it is valid for a given token on a specified blockchain. Returns: address, blockchain, token. Required: address, blockchain, token.
• Create Create a Circle contract execution estimate fee Estimate gas fees for a contract execution transaction in Circle. Returns estimated fee parameters including gasLimit, maxFee, and priorityFee. Required: either walletId or walletAddress with blockchain, plus contractAddress and ABI function parameters.
• Create Create a Circle transfer estimate fee Estimate gas fees for an on-chain transfer transaction in Circle, given its amount, blockchain, and token. Returns the estimated transaction fee including feeLevel, gasLimit, maxFee, priorityFee, and gasPrice. Required: amount, blockchain, token.
• Create Create a Circle transactions contract execution Create a challenge for a contract execution transaction from a user-controlled Circle wallet. ABI parameters must be passed in the request. Returns: id. To identify the wallet, provide either walletId or both walletAddress and blockchain in the request body.
• Create Create a Circle transactions wallet upgrade Create a challenge for a wallet upgrade transaction in Circle. Returns: challengeId. Required: the request body must identify the wallet using either walletId, or both walletAddress and blockchain.
• Cancel Circle developer transactions cancel Cancel a transaction from a developer-controlled wallet in Circle. This is a best-effort operation — gas fees may still be incurred and it won't be effective if the original transaction has already been processed by the blockchain. Returns the canceled transaction object including its id, state, and txHash. Required: transaction_id.
• Create Create a Circle transaction accelerate Create a challenge to accelerate a specific transaction from a user-controlled wallet in Circle. Returns: challengeId. Required: transaction_id, idempotencyKey. Additional gas fees may apply.
• Create Create a Circle user initialize Create a challenge for user initialization with wallet creation in Circle, setting a user's PIN and creating one or more wallets. Returns: challengeId. Required: idempotencyKey. Repeated requests with the same idempotency key return the original challenge instead of executing again.
• List List all Circle w 3 s users List all users under the entity in Circle. Returns: createDate, updateDate. Supports filtering by pin status, security question status, and date range.
• Create Create a Circle w 3 s user Create a new user in Circle's user-controlled wallet system. Returns: createDate, updateDate. Required: userId.
• Get Get single Circle w 3 s user by ID Get a Circle Web3 Services user by id. Returns the user object including userId, status, pinStatus, securityQuestionStatus, and createDate. Required: id.
• List List all Circle user challenges List all Circle user-controlled wallet challenges, optionally filtered by status. Returns: createDate.
• Get Get single Circle user challenge by ID Get a single Circle user-controlled wallet challenge by id. Returns: createDate. Required: id.
• Get Get single Circle users token by ID Create a user token in Circle by generating a user session and SDK encryption key pair for a given user. Returns: userToken, refreshToken, encryptionKey. Required: userId.
• Create Create a Circle user pin Create a challenge for PIN setup in Circle without creating wallets. Returns: challengeId. Idempotent requests return the existing challenge when the same idempotency key is reused.
• Update Circle user pins bulk update Create a challenge to update a user's PIN in Circle using the current PIN. Returns the created Pin challenge object including its challengeId. Requires a SetPin request body with the new PIN.
• Create Create a Circle pin restore Create a PIN restore challenge in Circle using security questions. Returns: challengeId. The request is idempotent — a matching idempotency key returns the existing challenge instead of creating a new one. Required: idempotencyKey.
• Create Create a Circle user wallet Generate a challenge to create a new user-controlled wallet or a batch of wallets in Circle. Returns: challengeId. Required: idempotencyKey, blockchains. The metadata array, if provided, must match the number of blockchains specified.
• Cancel Circle user transactions cancel Cancel a transaction from a user-controlled wallet in Circle by generating a challenge for the user to approve. Gas fees may still apply even when the transaction is canceled. Returns: challengeId. Required: transaction_id.
• Create Create a Circle social token Get a deviceToken to perform social login in Circle's W3S SDK. Returns: deviceToken. Device tokens expire after 10 minutes and only one active token is allowed per deviceId.
• Create Create a Circle email token Get a deviceToken for email OTP login in Circle. Returns the data object containing the deviceToken. Required: email, deviceId, appId. Tokens expire after 10 minutes; only one active token per deviceId.
• Create Create a Circle token refresh Refresh a Circle user token using the refreshToken obtained from SDK login. Returns: userToken. Required: refreshToken.
• Create Create a Circle email resend otp Resend an OTP email to a Circle W3S user when the original OTP email was not received. The prior OTP email expires after the new one is sent. Returns a confirmation that the OTP email was successfully resent.
• List List all Circle buidl transfers List Circle BUIDL transfers for the specified wallet addresses, optionally filtered by blockchain, state, transfer type, transaction hash, or user operation hash. Returns: id, createDate. Required: walletAddresses.
• Get Get single Circle buidl transfer by ID Retrieve an existing buidl transfer in Circle by its id. Returns the transfer object including id, userOpHash, txHash, state, transferType, blockchain, and createDate. Required: id.
• List List all Circle buidl user ops List user operations in Circle, filterable by blockchain, state, txHash, userOpHash, refId, and senders. Returns: id, createDate, updateDate.
• Get Get single Circle buidl user op by ID Get a single user operation in Circle by id. Returns: id, createDate, updateDate. Required: id.
• List List all Circle balances List expected token balances for a specified remote domain in Circle xReserve. Returns: data. Required: remote_domain. Optional filters: standard, name, tokenAddress.
• Get Get single Circle balance by ID Get token balances for specified addresses in Circle xReserve. Returns the current available balance for each address across the different domains where that address is valid, with the exact response field shape defined by the upstream BalancesResponse schema. Required: a request body specifying the addresses to query.
• List List all Circle nfts List NFTs held by a Circle wallet by blockchain and address in Circle. Returns: nftTokenId, tokenAddress, name, standard. Required: blockchain, address.
• Create Create a Circle screening address Screen a blockchain address in Circle by creating a compliance screening request for a specific address and chain. Returns: id. Required: address, chain.
• Create Create a Circle deploy estimate fee Estimate the fee required to deploy a contract from a template in Circle. Returns a fee estimation with estimated transaction fee values. Required: template_id.
• Create Create a Circle template deploy Deploy a smart contract from a template in Circle. Returns the template contract deployment object with deployment status and contract details. Supports idempotent requests — 201 for a new deployment, 200 if the contract was already created in a previous request. Required: template_id.
• List List all Circle w 3 s contracts List contracts in Circle that you've imported and/or deployed. Returns: id, name, description. Filterable by blockchain, contractInputType, deployerAddress, name, and status.
• Get Get single Circle w 3 s contract by ID Get a single contract in Circle by id (UUID). Retrieved using the contract ID, not the on-chain address. Returns: id, description, createDate. Required: id.
• Update Update a Circle w 3 s contract by ID Update the off-chain properties, such as description, of a contract in Circle by id (UUID). Returns: id, description, createDate. Required: id. An empty update body is not allowed.
• Create Create a Circle contracts query Execute a read-only query function on a smart contract in Circle. Query the state of a contract by providing its address and blockchain. Returns the contract state read result. Required: address, blockchain.
• Create Create a Circle contracts import Import an existing on-chain smart contract into your Circle contract library. Returns the imported contract including its id, address, blockchain, and status. The request is idempotent — a repeated call with the same idempotency key returns the original response (HTTP 200) instead of creating a duplicate. Required: idempotencyKey, address, blockchain.
• Create Create a Circle contracts deploy Deploy a smart contract on a specified blockchain in Circle using the contract's ABI and bytecode, deployed from one of your Circle Wallets. Returns: id, blockchain, status. Required: idempotencyKey (UUID v4), walletId, blockchain, bytecode.
• List List all Circle contracts monitors List Circle event monitors, optionally filtered by blockchain, contract address, and event signature. Returns: id.
• Create Create a Circle contracts monitor Create a new Circle event monitor for a given blockchain, contract address, and event signature. Returns: id. Required: blockchain, contractAddress, eventSignature.
• Update Update a Circle contracts monitor by ID Update an existing Circle event monitor by id. Returns: id, createDate. Required: id, blockchain, contractAddress, eventSignature.
• Delete Delete a Circle contracts monitor by ID Delete a Circle event monitor by id. Returns an empty response on success. Required: id.
• List List all Circle contracts events List Circle contract event logs, optionally filtered by blockchain and contract address. Returns: id.
• List List all Circle attestations Get a signed attestation for a USDC burn event on the source chain in Circle. Returns: attestation, status. Required: message_hash.
• List List all Circle public keys List the currently active attestation public keys in Circle. Returns: data.
• List List all Circle messages List CCTP V1 messages and attestation details for a source domain and transaction hash in Circle. Returns: attestation, message, eventNonce. Required: source_domain_id, transaction_hash.
• Get Get single Circle message by ID Get CCTP V2 messages and attestations for a source domain in Circle by transaction hash or nonce. Returns the messages array (each with message, eventNonce, attestation, decodedMessage, cctpVersion, status, forwardState, forwardTxHash) and sourceTxHash. Required: id.
• Create Create a Circle reattest Re-attest a pre-finality message in Circle to obtain a higher level of finality than originally requested on the source chain. Returns: message, nonce. Required: nonce.
• List List all Circle usdc allowances Retrieve the available USDC Fast Transfer allowance remaining in Circle. Returns: allowance, lastUpdated. The source documents only these two fields in the USDCFastBurnAllowanceResponseV2 schema.
• List List all Circle usdc fees Get USDC transfer fees in Circle for a transfer between the specified source and destination domains. Returns the applicable fee in basis points (1 = 0.01%). Required: source_domain_id, dest_domain_id.
• Create Create a Circle burn usdc Create a signed, time-bound fee quote for a native USDC transfer between two blockchains in Circle. The quote prices the upfront fees a caller must pay and includes a signedQuote blob that the TokenMessengerWithFees contract verifies onchain. Returns: signedQuote. Required: source_domain_id, dest_domain_id, amount, feeToken, requests. The destination domain must differ from the source domain;…
• Create Create a Circle estimate Estimate fees and expiration block heights for a transfer in Circle without requiring signatures or executing the transaction. Returns the estimated fees and expiration block heights as defined by the upstream EstimateResponse schema. Accepts an EstimateRequest request body with optional maxAttestationSize and enableForwarder query parameters.
• List List all Circle info Get Circle Gateway info for supported domains and tokens. Returns details of the supported domains and tokens along with general API information. No required parameters.
• Create Create a Circle transfer Create a transfer attestation in Circle for transferring tokens between domains, generating a transfer attestation and operator signature. Returns: id. A request body with transfer attestation details is required.
• Get Get single Circle transfer by ID Get a single transfer by id in Circle, returning detailed transfer information including attestation and operator signature data. Returns: id. Required: id.
• List List all Circle transfer specs Get the full TransferSpec in Circle by its keccak256 hash. Returns the complete TransferSpec information object for the specified transfer spec hash. Required: transfer_spec_hash.
• Get Get single Circle deposit by ID Get pending deposits for specified blockchain depositor addresses in Circle. Returns a data array of pending deposit records, each with id, amount, status, source, destination, and createDate. Required: addresses.
• Create Create a Circle batch submit Submit an EIP-3009 single-chain transfer authorization to Circle for batch processing. The authorization is verified, the sender's balance locked, and the transaction queued. Returns: id. Required: request body containing the EIP-3009 transfer authorization. A 409 response is returned if the nonce has already been used.
• Create Create a Circle x 402 settle Settle an x402 payment in Circle by submitting the EIP-3009 authorization. The authorization is verified, the sender's balance is locked, and the transaction is queued for batch processing. Returns: success, errorReason, payer, transaction, network. Required: paymentPayload, paymentRequirements.
• List List all Circle x 402 supporteds List the x402 payment kinds supported by Circle Gateway for batching. Returns: kinds, extensions, signers.
• Get Get single Circle x 402 transfer by ID Get a single Circle x402 transfer by id. Returns: id, createDate. Required: id.
• List List all Circle x 402 transfers List Circle x402 transfers with filters by sender, recipient, network, status, token, nonce, and date range. Returns: id. Beginning August 17, 2026, the status filter requires at least one of from, to, or nonce.
• Create Create a Circle x 402 verify Verify an x402 payment payload in Circle by running read-only validation checks (scheme, network, token, signature, temporal constraints, address/amount matching). Returns: isValid, invalidReason, payer. Required: paymentPayload, paymentRequirements. A valid result does not guarantee settlement — balance and nonce checks only happen at settle time.
• List List all Circle subscriptions permissionleses List all permissionless webhook subscriptions in Circle. Returns: id, name, endpoint, environment, enabled, addresses, domains, notificationTypes, createDate, updateDate. Filter results by environment using the optional environment query parameter.
• Create Create a Circle subscriptions permissionlese Create a permissionless webhook subscription in Circle to receive Gateway event notifications. Returns: id, name, endpoint, environment, enabled, addresses, domains, notificationTypes, createDate, updateDate. Required: environment, endpoint, addresses, domains, notificationTypes.
• Get Get single Circle subscriptions permissionlese by ID Get a single permissionless webhook subscription in Circle by id. Returns: id, createDate. Required: id.
• Update Update a Circle subscriptions permissionlese by ID Update a permissionless webhook subscription in Circle. Metadata fields (name, endpoint, enabled) can be updated independently; filter fields (notificationTypes, addresses, domains) must be provided together and fully replace existing filters. Returns: id, createDate. Required: id.
• Delete Delete a Circle subscriptions permissionlese by ID Delete a permissionless webhook subscription in Circle by id. Returns an empty 204 response on success. Required: id.
• Create Create a Circle permissionless test connection Test the connection to a Circle permissionless webhook subscription's subscriber endpoint, verifying that it is reachable. Returns: data. Required: permissionles_id.
• Create Create a Circle permissionless test Send a test notification (notificationType "webhooks.test") to the subscriber endpoint of a permissionless webhook subscription in Circle. Returns an empty 204 response on success. Required: permissionles_id.
• Create Create a Circle stablefx quote Create a StableFX quote for a trade between two currencies in Circle. Returns: id, type. Required: from, to, type. Provide an amount on either `from` or `to`, but not both; use type `tradable` for an executable quote (includes presign typedData) or `reference` for an indicative quote.
• List List all Circle stablefx trades List all StableFX trades in Circle, newest first by default. Returns each trade with id, from, to, status, createDate, updateDate, quoteId, settlementId, rate, and expectedBatchTime. Required: type.
• Create Create a Circle stablefx trade Create a StableFX trade in Circle by accepting a quote. Returns the created trade including id, from, to, status, createDate, updateDate, quoteId, settlementId, rate, and expectedBatchTime. Required: quoteId.
• Get Get single Circle stablefx trade by ID Get a single StableFX trade by id in Circle. Returns the trade detail including id, from, to, status, createDate, updateDate, quoteId, settlementId, rate, and expectedBatchTime. Required: id, type.
• Create Create a Circle stablefx signature Register a trade signature in Circle by submitting a signed EIP-712 payload from the trader that confirms trade intent. Returns the registered trade signature response object.
• Get Get single Circle stablefx fee by ID Get the fee associated with a specific StableFX trade in Circle by trade ID. Returns: id, createDate. Required: id (the trade ID).
• Get Get single Circle signatures presign by ID Generate trade presign data for a StableFX trade in Circle. Returns the EIP-712 Permit2 payload as typedData that the maker must sign to authorize the trade. Required: id, recipientAddress.
• Create Create a Circle funding presign Generate funding presign data for Circle StableFX trades, returning the Permit2 EIP-712 typed-data payload for the trader to sign. In delegate mode the response also includes a funder typed-data payload. Returns: typedData (the Permit2 EIP-712 typed data for the trader to sign), funderTypedData (the funder's typed data payload, present in delegate mode). Required: fundingMode. When fundingMode is…
• Create Create a Circle stablefx fund Execute funding for StableFX trades in Circle by relaying signed Permit2 permit data to complete the funding operation. When fundingMode is delegate, the request must include the trader's permit2 and signature along with the funder's funderPermit2 and funderSignature. Returns a 200 success response with no documented body content.
• List List all Circle settlement advances credits Get the maker's settlement-advance credit line in Circle. Returns the credit line including total limit, current usage, available headroom per currency, and the fee schedule with recurring, draw, and reservation fees.
• Create Create a Circle settlement advances reserve Reserve settlement advance credit in Circle to hold credit and lock in a fee snapshot before requesting a settlement advance. Returns the reservation object including id, amount, status, expiresAt, and createDate. Required: idempotencyKey, amount. Reservations expire after ~15 minutes and only one active reservation is allowed per currency.
• List List all Circle settlement advances reservations List settlement advance reservations in Circle, optionally filtered by status and currency. Results are ordered newest first. Returns: id. Max 100 per page.
• Get Get single Circle settlement advances reservation by ID Get a single settlement advance reservation in Circle by id. Returns: id, createDate. Required: id.
• Cancel Circle settlement advances reservations cancel Cancel an active settlement advance reservation in Circle, releasing held credit back to the line. Only reservations in active status can be canceled. Returns: id. Required: reservation_id.
• Create Create a Circle settlement advances presign Generate Permit2 typed-data for signing a settlement advance in Circle StableFX. Returns typed-data the maker signs to authorize delegate funding of their side of a trade, using a zero-amount DelegateFundingAuthorization witness so no tokens transfer from the maker. Requires a request body. Stateless with no persistence or side effects.
• List List all Circle stablefx settlement advances List settlement advances in Circle with their lifecycle status, filterable by status and creation date range. Returns: id. Max 100 per page.
• Create Create a Circle stablefx settlement advance Request a settlement advance in Circle by submitting a Permit2 signature and witness payload for a trade. Returns: id. Required: tradeId. Funding runs asynchronously; idempotent on tradeId.
• Get Get single Circle stablefx settlement advance by ID Get a single settlement advance by id in Circle, including its lifecycle status, advance and collateral amounts, fee information, and repayments applied. Returns: id, status, createDate. Required: id.
• Create Create a Circle settlement advances repayment Record a repayment against the credit line backing a settlement advance in Circle. Returns: id. Required: idempotencyKey, amount. For USDC and EURC, round the amount up to 2 decimal places; other stablecoins are not subject to rounding. Idempotent on idempotencyKey — replays with the same key and amount are no-ops.
• Get Get single Circle settlement advances repayment by ID Get a settlement advance repayment in Circle by id. Returns: id, createDate. Required: id.
• List List all Circle remote domain attestations List attestations for crosschain transfers in Circle, filtered by remote domain. Returns: data. Required: remote_domain.
• Create Create a Circle prepare withdrawal Prepare a withdrawal in Circle xReserve by converting remote-chain burn transaction data into fully encoded burn intents for the /withdraw endpoint. Returns: maxBlockHeight, maxFee. The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the prepared burn intent.
• Create Create a Circle withdraw Submit signed burn intents for withdrawal in Circle. Submits up to five signed burn intent batches per request call, with each batch containing one or up to 10 burn intents. Returns: withdrawalId, burnTxId, success. Required: burnTxId and signatures in the request body. At most 5 batches per call; a 409 Conflict is returned if the burnTxId is already associated with an active withdrawal.
• Get Get single Circle withdrawal by ID Get the status and transfer details of a specified withdrawal group in Circle. Returns: id, status, createDate, data. Required: id.
• List List all Circle partner clients List partner clients in Circle, newest first. Returns each client's clientEntityId, created, clientName, country, clientType, businessDetails, status, and balances (status and balances are Circle-enriched and may be omitted). Max 100 per page.
• Create Create a Circle partner client Create a partner client in Circle and initialize an onboarding application in a single request. Returns: clientEntityId, applicationId, created, clientName, country, clientType, businessDetails, status, balances. Required: clientName, country. A duplicate clientName and country combination returns 409 Conflict.
• Get Get single Circle partner client by ID Get a single partner client in Circle by id. Returns: clientEntityId, created, clientName, country, clientType, businessDetails, status, balances (status and balances are Circle-enriched and may be omitted). Required: id.
• List List all Circle business account balances List available and unsettled fund balances for a Circle business account. Returns the data object containing available and unsettled balance arrays, each entry with amount and currency. Optionally filter by walletId.
• List List all Circle business account payouts List all payouts for your Circle business account, with optional filters by destination bank account type, status, and source wallet. Returns: id, sourceWalletId, destination, amount, toAmount, fees, status, errorCode, riskEvaluation, adjustments, return, createDate, updateDate. This endpoint does not return the tracking reference number for payouts; retrieve each payout individually by ID for…
• Create Create a Circle business account payout Create a redemption (offramp) payout in Circle that converts a digital asset to fiat currency. Returns: data.
• Get Get single Circle business account payout by ID Get a single business account payout in Circle by id. Returns the full payout object including id, sourceWalletId, destination, amount, fees, status, trackingRef, riskEvaluation, adjustments, return, createDate, and updateDate. Required: id.
• List List all Circle banks wires List all wire bank accounts in Circle. Returns: id, type, status, description, trackingRef, fingerprint, billingDetails, bankAddress, virtualAccountEnabled, ffcMemo, policyEvaluation, createDate, updateDate, transferTypesInfo.
• Create Create a Circle banks wire Create a new wire bank account in Circle for wire transfers. Returns the created wire account including id, type, status, trackingRef, transferTypesInfo, billingDetails, bankAddress, createDate, and updateDate. Required: billingDetails, bankAddress.
• Get Get single Circle banks wire by ID Get a specific wire bank account in Circle by id. Returns: data. Required: id.
• List List all Circle wire instructions Get wire transfer instructions for a Circle bank account. Returns: data. Required: wire_id.
• Create Create a Circle payments wire Create a mock wire payment in the Circle sandbox that simulates funds sent through the bank (wire) account linked to the master wallet. Returns the mock wire payment object including trackingRef, amount, beneficiaryBank, and status. Required: amount, beneficiaryBank.
• List List all Circle banks cubixes List all CUBIX bank accounts in Circle. Returns: id, status, trackingRef, accountId, transferTypesInfo, policyEvaluation, createDate, updateDate.
• Create Create a Circle banks cubix Create a new CUBIX bank account in Circle for CUBIX transfers. Returns: id, status, trackingRef, accountId, transferTypesInfo, policyEvaluation, createDate, updateDate.
• Get Get single Circle banks cubix by ID Get a single CUBIX bank account in Circle by id. Returns: id, status, trackingRef, accountId, transferTypesInfo, policyEvaluation, createDate, updateDate. Required: id.
• List List all Circle instructions Get ACH deposit instructions for a specific Circle bank account. Returns the instructions data object including trackingRef and accountId. Required: ach_id.
• List List all Circle business account transfers List all transfers from your Circle business account, ordered by most recent when date filters are omitted. Returns: id, source, destination, amount, fees, transactionHash, status, errorCode, policyEvaluation, createDate, customerExternalRef. Max 50 per page.
• Create Create a Circle business account transfer Create a transfer from a Circle business account to a blockchain destination. When amount.currency is CIRBTC, the recipient's chain (looked up from destination.addressId) determines whether an onchain cirBTC transfer or a native Bitcoin redemption is performed. Returns the created transfer including id, source, destination, amount, status, createDate, and transactionHash. Required: source,…
• Get Get single Circle business account transfer by ID Get a single Circle business account transfer by id. Returns: id, source, destination, amount, fees, transactionHash, status, errorCode, policyEvaluation, createDate, customerExternalRef. Required: id.
• List List all Circle business account associated accounts List sibling Circle accounts (CMAs) associated with the current account under unified credentials, usable as destinations for cross-entity transfers. Returns: entityId, nickname.
• List List all Circle addresses deposits List all Circle account deposit addresses, optionally filtered by account, blockchain, currency, or wallet. Returns: address, addressTag, currency, chain, id, accountId, walletId.
• Create Create a Circle addresses deposit Create a new Circle deposit address for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. Returns: data. Required: currency, chain.
• Get Get single Circle addresses deposit by ID Get a single Circle account deposit address by id. Returns: data. Required: id.
• List List all Circle addresses recipients List all verified recipient addresses in Circle that are eligible for transfers. Returns: id, address, addressTag, chain, currency, description, status. Addresses pending administrator verification are excluded from the response.
• Create Create a Circle addresses recipient Create a recipient address in Circle to store an external blockchain address for transfers. Returns: data. Required: address, chain. The recipient address must be verified after creation before it can be used for transfers.
• Delete Delete a Circle addresses recipient by ID Delete a recipient address in Circle by id. The recipient address must be in an 'active' or 'pending' state to be deleted successfully. Returns an empty 200 response on success. Required: id.
• Get Get single Circle addresses recipient by ID Get a specific recipient address in Circle by id. Returns: data. Required: id.
• List List all Circle business account deposits List deposits sent to your Circle business account in descending chronological order. Returns: id, sourceWalletId, destination, amount, fee, status, riskEvaluation, customerExternalRef, createDate, updateDate, source, fromAmount, fees, externalRef, trackingRef. Returns up to 50 deposits per page.
• Get Get single Circle business account deposit by ID Get a single Circle business account deposit by id. Returns: id, sourceWalletId, destination, amount, fee, status, riskEvaluation, customerExternalRef, createDate, updateDate, source, fromAmount, fees, externalRef, trackingRef. Required: id.
• List List all Circle banks pixes List all PIX bank accounts in Circle. Returns: id, status, description, trackingRef, transferTypesInfo, riskEvaluation, policyEvaluation, fingerprint, createDate, updateDate.
• Create Create a Circle banks pix Create a PIX bank account in Circle for BRL transfers. Returns: id, status, description, trackingRef, transferTypesInfo, riskEvaluation, policyEvaluation, fingerprint, createDate, updateDate.
• Get Get single Circle banks pix by ID Get a single PIX bank account in Circle by id. Returns: id, status, description, trackingRef, transferTypesInfo, riskEvaluation, policyEvaluation, fingerprint, createDate, updateDate. Required: id.
• List List all Circle wire routing infos List wire routing information for a Circle fiat account, including available settlement banks and current routing configuration for both inbound and outbound wires. Returns: currency, inbound, outbound. Required: fiat_account_id.
• Update Circle wire routing preferences bulk update Update wire routing preferences for a Circle wire fiat account, creating or updating the settlement bank routing configuration. Returns: currency, inbound, outbound. Required: fiat_account_id, and at least one of inboundBankLabel or outboundBankLabel in the request body. Rejects updates if the account has active Express routes configured.
• List List all Circle routing infos List PIX routing information for a Circle fiat account, including available settlement banks and current routing configuration for inbound and outbound transfers. Returns: data. Required: fiat_account_id.
• Update Circle routing preferences bulk update Update PIX settlement bank routing preferences for a Circle fiat account in Circle. At least one of inboundBankLabel or outboundBankLabel must be provided; the endpoint rejects updates when the account has active Express routes configured. Returns: currency, inbound, outbound. Required: fiat_account_id.
• List List all Circle redemption daily reports List burn fee calculations in Circle, including daily records and surcharges. Returns: id, fee, cumulatedPayoutAmount, cumulatedPaymentAmount, cumulatedNetAmount, valueDate, status, thresholdResetTimestamp, createDate, updateDate, feeType, redemptionMode, aggregationLevel, billingPeriodStart, billingPeriodEnd. Returns up to 50 calculations in descending chronological order.
• List List all Circle reports List previously generated reports in Circle for a given report type and date range. Returns: id, reportType, timeframe, reportDate, downloadUrl, expiresAt. Required: reportType, startDate, endDate. The `id` returned is a storage object key, not a report UUID — download listed reports via their `downloadUrl`. The non-managed `camt053` type is not supported here.
• Create Create a Circle report Request a report in Circle by specifying a report type and date. Returns: id, reportType, status, downloadUrl, expiresAt. When the report is not yet ready, status is `pending` (HTTP 202) and downloadUrl is omitted. Requests are idempotent — retries return the existing report. Required: reportType, date.
• Get Get single Circle report by ID Get metadata for a single Circle report by id, including a fresh pre-signed downloadUrl when the report is ready. Returns: id, reportType, status, downloadUrl, expiresAt. Use this to poll a pending report or to refresh an expired download URL. Required: id.
• List List all Circle contents Download the raw report content from Circle as a binary file stream. Returns an opaque binary file download whose content varies by report type (e.g., application/xml). Required: report_id. Returns 409 if the report is not yet ready.
• List List all Circle configurations Get general Circle account configuration information. Returns: payments. No additional fields are documented in the source for this endpoint.
• List List all Circle stablecoins List all supported stablecoins in Circle with total circulating supply broken down across all chains. Returns: name, symbol, totalAmount, chains. Rate limited to one call per minute based on IP.
• List List all Circle external entities List all external entities for the institutional account in Circle. Returns: walletId, businessName, businessUniqueIdentifier, identifierIssuingCountryCode, complianceState. The businessUniqueIdentifier and identifierIssuingCountryCode query parameters are an all-or-nothing pair — supplying only one results in an error.
• Create Create a Circle external entity Create an external entity for the institutional account in Circle. Returns the created entity including walletId, businessName, businessUniqueIdentifier, identifierIssuingCountryCode, and complianceState. Required: businessName, businessUniqueIdentifier, identifierIssuingCountryCode. A 409 conflict is returned if an entity with the same businessUniqueIdentifier and identifierIssuingCountryCode…
• Get Get single Circle external entity by ID Get a single external entity by wallet ID in Circle. Returns: walletId, businessName, businessUniqueIdentifier, identifierIssuingCountryCode, complianceState. Required: id.
• List List all Circle payments List all Circle payments including fiat payments, crypto payments, cancels, and refunds. Returns: id, type, status, amount, fromAmount, fees, networkFees, merchantId, merchantWalletId, source, description, captured, captureAmount, captureDate, requiredAction, cancel, refunds, channel, paymentIntentId, settlementAmount, fromAddresses, depositAddress, transactionHash, originalPayment, reason,…
• Get Get single Circle payment by ID Get a single Circle payment by id, which may be a fiat payment, crypto payment, cancel, or refund. Returns: id, type, createDate, data. Required: id.
• List List all Circle payment intents List all payment intents in Circle. Returns each intent with id, amount, currency, amountPaid, settlementCurrency, paymentMethods, paymentIds, customerWalletId, timeline, type, createDate, and updateDate. Supports filtering by status and context.
• Create Create a Circle payment intent Create a continuous (default) or transient payment intent in Circle. Returns the created intent with id, amount, amountPaid, settlementCurrency, paymentMethods, timeline, purposeOfTransfer, expiresOn, customerWalletId, customerExternalRef, type, createDate, and updateDate. Required: idempotencyKey, paymentMethods. Set type to 'transient' for a transient intent; purposeOfTransfer is conditionally…
• Get Get single Circle payment intent by ID Get a single Circle payment intent by id. Returns: id, amount, currency, amountPaid, settlementCurrency, paymentMethods, paymentIds, customerWalletId, timeline, type, createDate, updateDate. Required: id.
• Create Create a Circle expire Expire a payment intent in Circle. Returns the expired payment intent object including id, amount, amountPaid, settlementCurrency, paymentMethods, timeline, createDate, and updateDate. Required: paymentintent_id.
• Create Create a Circle refund Create a crypto refund for a Circle payment intent. Returns the refund object including its id, type, status, settlementAmount, fromAddresses, depositAddress, paymentId, createDate, and updateDate. Required: paymentintent_id.
• List List all Circle payments customers List crypto payment customers in Circle for eligible Circle Singapore merchants. Returns: id, refId, type, status. List responses omit customer PII.
• Create Create a Circle payments customer Create a Travel Rule customer profile for crypto payment attribution in Circle. Returns the created customer including id, refId, type, status, firstName, lastName, dateOfBirth, placeOfBirth, governmentIssuedId, and address. The customer starts in pending status while screening completes. Required: type.
• Get Get single Circle payments customer by ID Get a single crypto payment customer by id in Circle, including full customer PII details. Returns: id, refId, type, status, firstName, lastName, dateOfBirth, placeOfBirth, governmentIssuedId, address. Required: id.
• List List all Circle customer wallets List crypto payment customer wallets for a Circle customer. Returns: id, customerId, chain, type, vaspId. Required: customer_id.
• Create Create a Circle customer wallet Create a hosted crypto payment customer wallet for an approved Travel Rule customer in Circle. The resulting wallet ID can be supplied as customerWalletId when creating a transient payment intent. Returns: id, customerId, chain, type, vaspId. Required: customer_id. The customer must be approved; available to eligible Circle Singapore (CIRCLE_SG) merchants.
• Get Get single Circle customer wallet by ID Get a single crypto payment customer wallet by id in Circle. Returns: id, customerId, chain, type, vaspId. Required: customer_id, id.
• Create Create a Circle payments refund address Create a crypto payment refund address-book entry in Circle for refunding a crypto payment intent (Circle Singapore refund flow 2). Returns the created refund address including id, chain, address, status, ownership, and createDate. Required: paymentId, chain, address, ownership. Do not provide identity — it is derived from the original payment's Travel Rule originator PII.
• List List all Circle payouts List all Circle payouts, optionally filtered by source wallet, destination, destination type, status, source currency, or destination currency. Returns: id, sourceWalletId, destination, amount, toAmount, fees, networkFees, customerExternalRef, status, errorCode, riskEvaluation, externalRef, createDate, updateDate. The address_book destination type cannot be combined with other destination types.
• Create Create a Circle payout Create a stablecoin payout in Circle. Returns: id, sourceWalletId, destination, amount, toAmount, fees, networkFees, purposeOfTransfer, customerExternalRef, status, errorCode, riskEvaluation, createDate, updateDate. Required: sourceWalletId, destination, amount. For CIRCLE_SG entities, purposeOfTransfer is also required and must use a valid payment reason code. Supported currency pairs for…
• Get Get single Circle payout by ID Get a single Circle payout by id. Returns the payout object including id, sourceWalletId, destination, amount, toAmount, fees, networkFees, status, errorCode, riskEvaluation, externalRef, createDate, and updateDate. Required: id.
• List List all Circle address book recipients List all address book recipients in Circle, with optional filters by address, chain, email, status, custody type, and VASP ID. Returns: id, chain, address, addressTag, metadata, status, identity, ownership, createDate, updateDate.
• Create Create a Circle address book recipient Create a new address book recipient in Circle. SG customers must additionally provide identity and ownership (metadata.email and beneficiary PII required for self-hosted entries). Returns: id, identity, ownership. Required: chain, address.
• Get Get single Circle address book recipient by ID Get a single address book recipient by id in Circle. Returns: id, chain, address, addressTag, metadata, status, identity, ownership, createDate, updateDate. Required: id.
• Update Update a Circle address book recipient by ID Update an address book recipient's metadata in Circle. Only metadata fields are accepted; identity and ownership are not allowed in PATCH requests. Returns: id, chain, address, metadata, status, createDate, updateDate. Required: id.
• Delete Delete a Circle address book recipient by ID Delete an address book recipient by id in Circle. Returns an empty 204 response on success. Required: id.
• Create Create a Circle verification cancel Cancel the pending verification session for a self-hosted wallet address book recipient in Circle. Returns an empty 200 response on success. Required: recipient_id. Only available for Singapore (CIRCLE_SG) entities; the recipient must have self-hosted custody type and be in pending_verification status. Returns 400 if the session is not cancelable (already canceled, expired, or verification…
• Create Create a Circle verification resend Resend a verification email for a self-hosted wallet address book recipient in Circle. Returns an empty 200 response on success. Required: recipient_id. Only available for Singapore (CIRCLE_SG) entities; the recipient must have self-hosted custody type and be in pending_verification status.
• List List all Circle address book vasps List active Virtual Asset Service Providers (VASPs) available for the customer's jurisdiction in Circle. Returns: id, name. Use returned id values as vaspId in ownership.custody when creating a recipient with hosted custody. Supported only for Circle Singapore (SG) customers.
• Get Get single Circle exchange quote by ID Get an indicative exchange rate quote between two currencies in Circle. Returns: id, rate, from, to, expiry, type, estimatedSettlementTime. Required: from, to. Either the from or to currency must be USD.
• List List all Circle exchange trades List all cross-currency FX trades in Circle. Returns: id, from, to, status, createDate, updateDate, quoteId, settlementId, rate, expectedBatchTime. An optional settlementId query parameter filters results to a specific settlement.
• Create Create a Circle exchange trade Create a cross-currency FX trade in Circle from a previously fetched quote. Returns: id, from, to, status, createDate, updateDate, quoteId. Required: quoteId.
• Get Get single Circle exchange trade by ID Get a single FX trade by id in Circle. Returns: id, from, to, status, createDate, updateDate, quoteId, settlementId, rate, expectedBatchTime. Required: id.
• List List all Circle trades settlements List all Circle exchange trade settlements, optionally filtered by type, status, or currency. Returns each settlement's id, entityId, status, createDate, updateDate, and a details array containing line items with their own amount, reference, and status.
• Get Get single Circle trades settlement by ID Get a single Circle exchange trade settlement by id. Returns: id, entityId, status, createDate, updateDate, details. Required: id.
• List List all Circle settlements instructions Get settlement instructions for a specific currency in Circle. Returns the settlement instructions data object including currency, fiatAccountType, and instruction with trackingRef, beneficiary, and beneficiaryBank details. Required: currency.
• Update Circle fx configs accounts bulk update Create a currency trading (FX) account in Circle. Returns: currency, fiatAccountId, createDate, updateDate. Required: currency.
• List List all Circle fx configs daily limits Get daily currency exchange limits and usages in Circle. Returns: data.dailyLimits, a map keyed by currency code (e.g. EURC, MXN, USDC, BRL) where each entry includes limit, usage, and available amounts. No required parameters.
• Create Create a Circle payments pix Create a mock PIX payment in the Circle sandbox environment that simulates funds sent through the bank account linked to the main wallet. Returns: trackingRef, amount, beneficiaryAccountNumber, status. Required: amount, beneficiaryAccountNumber.
• Create Create a Circle reserve management daily custody balance Create a daily custody balance report for USDC or EURC in Circle. Returns: idempotencyKey, id, createDate, localBalance, currency, asOfDate, reportType, additionalFields. Required: idempotencyKey, currency, asOfDate, localBalance, reportType, additionalFields. Only one submission per day per currency; USDC and EURC require separate submissions.
• List List all Circle credits Get credit line details from Circle, including status, available limit, and outstanding balance. Returns the data object with id, product, status, limit, used, available, outstandingTransfers, feeRates, unpaidFees, minBalance, feeCadence, validationErrors, createDate, updateDate.
• Get Get single Circle credit repayment account by ID Get repayment account details and wire instructions for a credit repayment in Circle. Returns: id, description, status, wireInstructions. Required: id.
• List List all Circle credit transfers List all credit transfers in Circle, filterable by status and create date range. Returns: id, amount, status, dueDate, disbursedDate, paidDate, createDate, updateDate. List items exclude outstanding and fees properties.
• Create Create a Circle credit transfer Create a credit transfer (drawdown) from the credit line in Circle. Disbursement is asynchronous. Returns: id, amount, status, blockchainDestination, createDate, updateDate. Required: idempotencyKey, amount. Only available for Line of Credit products.
• Get Get single Circle credit transfer by ID Get a single credit transfer in Circle by id. Returns: id, createDate, data. Required: id. Outstanding, fees, dueDate, and disbursedDate appear only once the transfer reaches disbursed, paid, or past_due status.
• Create Create a Circle transfers reserve fund Reserve funds for a Settlement Advance credit transfer draw in Circle. Returns the credit transfer with id, amount, status, expiresAt, createDate, and updateDate. Required: idempotencyKey, amount. Reserved funds expire after 30 minutes; only one funds_reserved transfer is allowed per credit line at a time. Only available for Settlement Advance products.
• Update Circle transfer request reserved funds bulk update Request reserved funds for a Settlement Advance credit transfer in Circle, transitioning a funds_reserved transfer to requested status by uploading wire proof evidence. Returns: id, amount, status, outstanding, fees, dueDate, disbursedDate, paidDate, expiresAt, blockchainDestination, createDate, updateDate. Required: transfer_id, fileName, fileContent. Only available for Settlement Advance…
• Cancel Circle transfer cancel reserves bulk update Cancel reserved funds for a Settlement Advance credit transfer in Circle, releasing the reserved amount back to available credit. Returns: id, amount, status, createDate, updateDate. Required: transfer_id. The transfer must be in funds_reserved status; this endpoint is only available for Settlement Advance products.
• List List all Circle credit fees List all credit fees in Circle, returning a paginated history of fees charged on the credit line. Returns: id, transferId, amount, status, accruedDate, createDate, updateDate. Filterable by create date range, currency, status, and transfer ID.
• Get Get single Circle credit fee by ID Get a single credit fee in Circle by id. Returns: id, transferId, amount, status, accruedDate, createDate, updateDate. Required: id.
• List List all Circle credit repayments List all credit repayments in Circle, including both fiat and crypto types. Returns: id, transferId, repaymentAccountId, amountApplied, paymentAmount, type, status, settlementDate, createDate, updateDate. Filterable by transfer ID, type, status, and create date range.
• Get Get single Circle credit repayment by ID Get a single credit repayment by id in Circle. Returns: id, transferId, repaymentAccountId, amountApplied, paymentAmount, type, status, settlementDate, createDate, updateDate. Required: id.
• Create Create a Circle credit crypto repayment Initiate a crypto repayment for a credit transfer in Circle. Returns: id, amount, status, createDate, updateDate. Required: idempotencyKey, amount. Only available for Line of Credit products; the requested amount is capped at the outstanding balance.
• Create Create a Circle mocks repayment Create a mock wire repayment in the Circle sandbox that simulates an incoming wire payment to repay an outstanding credit transfer. The fiat account is automatically linked as a repayment account if not already linked. Returns: trackingRef, amount, status. Required: amount. Available only in the sandbox environment.
• List List all Circle partner applications List Circle partner onboarding applications for the authenticated partner. Returns each application's id, status, createDate, and updateDate. Filter by status to narrow results; valid statuses are APPROVED, CANCELLED, DENIED, DRAFT, IN_REVIEW, PENDING_CUSTOMER_INFORMATION, and SUBMITTED.
• Get Get single Circle partner application by ID Get a single Circle partner onboarding application by id. Returns the application's id, status, createDate, and updateDate. Required: id.
• Delete Delete a Circle partner application by ID Cancel a draft Circle onboarding application by id. Only DRAFT applications are cancellable; other operation types are not currently cancellable. Returns the cancelled application object including its id and status. Required: id. Returns 409 if the application cannot be cancelled in its current state.
• List List all Circle application certifications List active certifications for a Circle onboarding application. Returns: certificationId, htmlContent, metadata. The returned ids can be passed back as certificationIds on application submit to explicitly acknowledge them. Required: application_id.
• List List all Circle data List all visible section data for a Circle onboarding application. The data object is keyed by section name and is round-trip compatible with the bulk update endpoint. Returns: data. Required: application_id.
• Update Circle data bulk update Save data for multiple sections of a Circle onboarding application in a single atomic request. Validation is atomic: if any section fails validation the entire request is rejected. Array sections use upsert semantics (items with refId update, items without refId create). Returns: data. Required: application_id.
• List List all Circle application documents List documents uploaded for a Circle onboarding application. Returns: id. Required: application_id.
• Create Create a Circle application document Upload a document to a Circle onboarding application. Returns: id. Required: application_id, documentType.
• Delete Delete a Circle application document by ID Delete a document from a Circle onboarding application. Returns an empty 204 response on success. Required: application_id, id.
• Get Get single Circle application document by ID Download a document file from a Circle onboarding application. Returns the document file content as a binary stream (application/octet-stream) that cannot be enumerated as JSON fields. Required: application_id, id.
• List List all Circle application rfis List RFI bundles with items for a Circle onboarding application. Returns: id, type. Required: application_id.
• Update Update a Circle application rfi by ID Submit field data in response to an UPDATE_FIELD or NEW_FIELD RFI in Circle onboarding. Returns: id, type, createDate. Required: application_id, id.
• Get Get single Circle application rfi by ID Get RFI detail with comment history for a Circle onboarding application. Returns: id, type, createDate, algorithm, publicKey. Required: application_id, id.
• Create Create a Circle application rfi Add a comment to an RFI in a Circle onboarding application. Returns: id, createDate, updateDate. Required: application_id, rfi_id.
• Update Update a Circle rfi comment by ID Update a comment on an RFI in Circle. Returns: id, createDate, updateDate, algorithm, publicKey. Required: application_id, rfi_id, id.
• Delete Delete a Circle rfi comment by ID Delete a comment on an RFI in Circle. Returns an empty 204 response on success. Required: application_id, rfi_id, id.
• List List all Circle application schemas Get the JSON Schema (draft 2020-12) for a Circle application's onboarding template. Returns a JSON Schema document whose structure varies by application template, including an x-resolved marker when the resolved query parameter is true. Required: application_id.
• List List all Circle application sections List sections for a Circle onboarding application with their statuses, optionally including field data when includeData is set. Returns the section list with content-type-specific fields. Required: application_id.
• Update Update a Circle application section by ID Save field data for a section of a Circle onboarding application. Returns the saved section data with updated section statuses. Required: application_id, id. Body structure is defined by the section's JSON Schema; for array sections, maxItems is enforced.
• Delete Delete a Circle application section by ID Remove an entity from an array section of a Circle onboarding application. Returns the updated section list with content-type-specific fields. Required: application_id, section_name, id.
• Get Get single Circle application section by ID Retrieve field data for a specific section of a Circle onboarding application. Returns the section data object with content-type-specific fields. Required: application_id, id.
• Create Create a Circle application submit Submit a Circle onboarding application for review. Returns: id. Required: application_id. The application must be in a submittable state.
• List List all Circle configurations overviews Get the payment configuration overview in Circle showing supported countries, currencies, payment methods, and blockchains. Returns: countries, currencies, paymentMethods, blockchains.
• List List all Circle configurations routes List supported payment routes in Circle. Returns route details including trade limits and valid corridors that determine which parameters are accepted for subsequent quote creation.
• Create Create a Circle cpn quote Create one or more CPN quotes in Circle for given source/destination parameters. Returns: id. Provide either sourceAmount or destinationAmount; quotes are sorted ascending by sourceAmount when based on destinationAmount, or descending by destinationAmount when based on sourceAmount.
• Get Get single Circle cpn quote by ID Get details of a specific CPN quote in Circle by id. Returns: id. Required: id.
• List List all Circle cpn payments List Circle CPN payments filtered by status, customer reference ID, reference code, and date range. Returns: id.
• Create Create a Circle cpn payment Create a Circle CPN payment from a previously created quote, submitting recipient travel rule information. The payment remains valid if onchain settlement occurs before settlementExpireDate. Returns: id. Required: idempotencyKey.
• Get Get single Circle cpn payment by ID Get a Circle CPN payment by id, including PII fields needed for travel rule and beneficiary account data. Returns: id, createDate. Required: id.
• List List all Circle payments requirements Get payment requirements for a CPN quote in Circle, retrieving the PII fields needed to collect to make a payment (travel rule and beneficiary account data). Returns the payment requirements object with quote-specific PII field requirements. Required: quoteId.
• Create Create a Circle payment transaction Create an unsigned onchain transaction for a specific payment in Circle. Returns: id. Required: payment_id, idempotencyKey.
• Get Get single Circle payment transaction by ID Get a specific transaction by its ID for a given payment in Circle. Returns: id, createDate, updateDate, algorithm, publicKey. Required: payment_id, id.
• Create Create a Circle transactions accelerate Accelerate a stuck onchain transaction for a CPN payment in Circle. Creates a new transaction with the same params as the newest broadcasted one so OFI can re-sign with a higher gas fee and resubmit via /submit. Returns the transaction object including id, state, and createDate. Required: payment_id. All existing transactions for the payment must be in FAILED or BROADCASTED state; no COMPLETED,…
• List List all Circle payment rfis Get details for a specific RFI (Request for Information) on a Circle CPN payment. Returns the RFI record (data) including its id. Required: payment_id, rfi_id.
• Create Create a Circle rfi submit Submit encrypted RFI data to complete an RFI request from the BFI in Circle CPN. Returns the RFI response object including its data. Required: payment_id, rfi_id. The request body carries encrypted RFI data whose field structure is defined by the upstream SubmitRfi schema.
• Create Create a Circle rfi file Upload an encrypted RFI file to a specific RFI for a CPN payment in Circle. The request body is sent as multipart/form-data containing the encrypted file. Returns an empty 204 response on success. Required: payment_id, rfi_id.
• List List all Circle payment refunds Get a specific refund associated with a CPN payment in Circle. Returns the full refund object including id, type, status, amount, merchantId, paymentId, settlementAmount, depositAddress, createDate, and updateDate. Required: payment_id, refund_id.
• Create Create a Circle cpn support ticket Create a support ticket in Circle CPN for transaction-related issues such as settlement delays, missing information, or refunds. Returns: id. Tickets are stored centrally in the CPN platform and routed to the appropriate party for resolution.
• List List all Circle accounts List all Circle accounts available to the calling entity, with optional filters by type, purpose, attribution, status, group, and date range. Returns: accountId, entityId, clientEntityId, type, purpose, status, description, balances, businessPii, groupId, id.
• Create Create a Circle account Create a new Circle account for Mint (purpose custody, type first_party or third_party) or Managed Payments intermediary (purpose payments, type first_party). Including businessPii routes to the intermediary flow; omitting it creates a standard custody account. Returns: data. Required: type, purpose.
• Get Get single Circle account by ID Get a single Circle account by id. Returns: data. Required: id.
• Update Update a Circle account by ID Update a Circle account by id, changing only the mutable fields included in the request body; omitted fields are left untouched. Returns the updated account object including id, type, purpose, status, createDate, and updateDate. Required: id.
• Archive Circle accounts archive Archive a subledger account in Circle. The account must have a zero balance and only subledger-type accounts created via POST /v1/accounts may be archived. Returns: data. Required: account_id. Archiving is idempotent; an incoming deposit to a pre-existing deposit address will auto-unarchive the account.
• List List all Circle accounts groups List custody account groups owned by the calling entity in Circle. Each row includes an aggregate USD-equivalent balance and a short preview of member account names. Returns: id, name.
• Create Create a Circle accounts group Create a new custody account group in Circle. If accountIds is provided, those accounts are assigned to the new group in the same transaction. Returns: data. Required: name.
• Get Get single Circle accounts group by ID Get a single custody account group in Circle by id. Returns the metadata view only: id, name, createDate, updateDate. Required: id.
• Update Update a Circle accounts group by ID Rename a custody account group in Circle by id. The new name must be unique (case-insensitive) within the calling entity. Returns: data. Required: id, name.
• Delete Delete a Circle accounts group by ID Delete a custody account group in Circle by id. Soft-deletes the group and all member assignments in a single transaction; member accounts are left untouched. Returns an empty 204 response on success. Required: id.
• Assign Circle accounts groups assign Bulk-assign up to 100 accounts to a Circle custody account group atomically. Accounts already bound to another group are reassigned. Returns: data. Required: group_id, accountIds. The entire request fails if any account is not found or does not belong to the caller's entity.
• Action Circle accounts groups unassign Bulk-remove up to 100 accounts from a Circle custody account group. All-or-nothing: every listed account must currently belong to the group. Returns: data. Required: group_id, accountIds. Fails with 404 if any listed account is not currently in the group.
• List List all Circle accounts transfers List all account transfers in Circle, including internal account-to-account transfers, onchain deposits, and onchain withdrawals. Returns: id, source, destination, amount, fees, transactionHash, status, errorCode, policyEvaluation, createDate. Max 50 per page.
• Create Create a Circle accounts transfer Create an internal account-to-account transfer in Circle between accounts under the same parent. Returns: data. Required: idempotencyKey, source, destination, amount. Both source and destination must be type account; cross-parent transfers are rejected.
• Get Get single Circle accounts transfer by ID Get a single account transfer in Circle by id. Returns: data. Required: id.
• List List all Circle accounts transactions List all account transactions in Circle, including deposits, withdrawals, transfers, and other activity. Returns: id, type, status, amount, destination, source, createDate, updateDate, transactionHash. Results are returned in descending chronological order; if date parameters are omitted, the most recent transactions are returned.
• List List all Circle banks aches List all ACH bank accounts in Circle. Returns: id, type, status, description, fingerprint.
• Create Create a Circle banks ach Create a bank account for ACH transfers in Circle. Returns the created ACH account including id, status, trackingRef, billingDetails, fingerprint, and createDate. Required: idempotencyKey.
• Get Get single Circle banks ach by ID Get a specific ACH bank account in Circle by id. Returns the bank account object including id, status, trackingRef, description, billingDetails, bankAddress, fingerprint, createDate, and updateDate. Required: id.
• List List all Circle accounts deposits List bank deposits sent to Circle accounts in descending chronological order. Returns: id, destination, amount, fee, status. Returns up to 50 deposits per page.
• Get Get single Circle accounts deposit by ID Get a single bank deposit in Circle by id. Returns: data. Required: id.
• List List all Circle accounts withdrawals List all bank withdrawals for Circle accounts, optionally filtered by payout status. Returns: id, destination, amount, fees, status, adjustments, return, description.
• Create Create a Circle accounts withdrawal Create a bank withdrawal from a Circle account, converting a digital asset to fiat currency and sending it to a specified destination bank account. Returns: data. Required: idempotencyKey, sourceWalletId, destination, amount.
• Get Get single Circle accounts withdrawal by ID Get a specific Circle account bank withdrawal by id. Returns the withdrawal object including id, status, amount, createDate, and updateDate. Required: id.
• List List all Circle credit lines Retrieve Managed Payments credit line details in Circle. Returns: id, limit, status, usage, createDate, updateDate, validationErrors. No required parameters.
• List List all Circle line wire instructions Get repayment wire transfer instructions for a Circle line of credit, used to repay funds borrowed against the credit line. Returns: data. Required: line_id.
• List List all Circle line transfers List credit transfers for a specific Circle Managed Payments credit line, filterable by status, date range, and receive job ID. Returns: id, amount, status, dueDate, disbursedDate, createDate, updateDate. Required: line_id.
• Create Create a Circle line transfer Borrow against a Circle Managed Payments credit line by initiating a transfer. Returns the created transfer including its id, amount, status, createDate, and updateDate. Required: line_id, idempotencyKey, amount.
• Get Get single Circle line transfer by ID Get a specific credit transfer by id for a Managed Payments credit line in Circle. Returns the transfer object including id, amount, status, outstanding, dueDate, disbursedDate, paidDate, createDate, and updateDate. Required: line_id, id. Fields outstanding, dueDate, and disbursedDate appear only when status is disbursed, paid, or past_due; paidDate appears only when status is paid.
• List List all Circle pix instructions Get PIX transfer instructions for a Circle PIX bank account. Returns: trackingRef, ispb, branchCode, accountNumber, accountType, taxId, name. Required: pix_id.

No tools match your search.