{"openapi":"3.1.0","info":{"title":"Circle Mint (BYOK) API","version":"0.1.0","description":"Circle Mint (BYOK) lets an AI assistant read your own Circle Mint data through the Circle Mint API with a key you supply (Circle API key). Read-only: 10 tools (list_balances, list_payouts, list_transfers, list_fiat_deposits, list_reports, list_stablecoins, list_fx_trades, list_fx_settlements, list_payment_intents, list_payments). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-circlemint.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-circlemint/docs"},"termsOfService":"https://connectorbay.com/byok-circlemint/terms"},"servers":[{"url":"https://byok-circlemint.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-circlemint/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_balances":{"post":{"operationId":"list_balances","summary":"Show the available and unsettled balances of the Circle Mint business account (or one wallet) per currency. Use for \"Wha","description":"Show the available and unsettled balances of the Circle Mint business account (or one wallet) per currency. Use for \"What is my available USDC balance in Circle\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"wallet_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this wallet ID (default: the account's main wallet).","title":"Wallet Id"}},"title":"list_balancesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payouts":{"post":{"operationId":"list_payouts","summary":"List payouts from the business account to bank accounts with amount, fees, status, error code, destination name (masked)","description":"List payouts from the business account to bank accounts with amount, fees, status, error code, destination name (masked) and dates. Use for \"Which Circle payouts are still pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only payouts in this status, for example pending, complete or failed.","title":"Status"},"type":{"anyOf":[{"enum":["wire","cubix"],"type":"string"},{"type":"null"}],"default":null,"description":"Destination bank account type.","title":"Type"},"source_wallet_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only payouts created from this wallet ID.","title":"Source Wallet Id"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_payoutsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transfers":{"post":{"operationId":"list_transfers","summary":"List transfers in and out of the business account, including onchain transfers, with amount, fees, status, chain and tra","description":"List transfers in and out of the business account, including onchain transfers, with amount, fees, status, chain and transaction hash. Use for \"Show Circle transfers from last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"wallet_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only transfers to or from this wallet ID.","title":"Wallet Id"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_transfersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_fiat_deposits":{"post":{"operationId":"list_fiat_deposits","summary":"List fiat (wire) deposits into the business account with amount, fee, status, risk decision and tracking reference. Use ","description":"List fiat (wire) deposits into the business account with amount, fee, status, risk decision and tracking reference. Use for \"Did my wire deposit arrive in Circle\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"wallet_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this wallet ID (default: the account's main wallet).","title":"Wallet Id"},"type":{"anyOf":[{"const":"wire","type":"string"},{"type":"null"}],"default":null,"description":"Deposit type filter.","title":"Type"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_fiat_depositsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_reports":{"post":{"operationId":"list_reports","summary":"List generated account reports (statements, payout and payin transactions, balances) for a date range, with report type,","description":"List generated account reports (statements, payout and payin transactions, balances) for a date range, with report type, timeframe, date and a time-limited download link. Use for \"Which Circle reports are available for September 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"report_type":{"description":"Report type to list.","enum":["managed_payout_transactions","managed_payment_wallet_balances","managed_payin_transactions","camt_managed","camt053","camt052","daily_statement_csv"],"title":"Report Type","type":"string"},"start_date":{"description":"First day, YYYY-MM-DD (in the past, not after end_date).","maxLength":10,"title":"Start Date","type":"string"},"end_date":{"description":"Last day, YYYY-MM-DD.","maxLength":10,"title":"End Date","type":"string"},"timeframe":{"anyOf":[{"enum":["daily","monthly"],"type":"string"},{"type":"null"}],"default":null,"description":"Only daily or only monthly reports.","title":"Timeframe"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"required":["report_type","start_date","end_date"],"title":"list_reportsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_stablecoins":{"post":{"operationId":"list_stablecoins","summary":"List Circle stablecoins (such as USDC and EURC) with total circulating supply overall and per blockchain. Use for \"How m","description":"List Circle stablecoins (such as USDC and EURC) with total circulating supply overall and per blockchain. Use for \"How much USDC is in circulation on each chain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_stablecoinsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_fx_trades":{"post":{"operationId":"list_fx_trades","summary":"List cross-currency (FX) trades with from and to amounts, rate, status, settlement ID and dates. Use for \"What FX trades","description":"List cross-currency (FX) trades with from and to amounts, rate, status, settlement ID and dates. Use for \"What FX trades did I execute with Circle this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["pending","confirmed","pending_settlement","complete","failed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only trades in this status.","title":"Status"},"currency":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only trades where from or to currency matches, for example EURC.","title":"Currency"},"category":{"anyOf":[{"enum":["swap","fiat"],"type":"string"},{"type":"null"}],"default":null,"description":"swap (stablecoin to stablecoin) or fiat (at least one fiat leg).","title":"Category"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_fx_tradesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_fx_settlements":{"post":{"operationId":"list_fx_settlements","summary":"List FX trade settlements with status, dates and the payable or receivable legs. Use for \"Which Circle FX settlements ar","description":"List FX trade settlements with status, dates and the payable or receivable legs. Use for \"Which Circle FX settlements are still pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["account_payable","account_receivable"],"type":"string"},{"type":"null"}],"default":null,"description":"Settlement type.","title":"Type"},"currency":{"anyOf":[{"enum":["MXN","BRL"],"type":"string"},{"type":"null"}],"default":null,"description":"Settlement currency.","title":"Currency"},"category":{"anyOf":[{"enum":["swap","fiat"],"type":"string"},{"type":"null"}],"default":null,"description":"swap or fiat trades.","title":"Category"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_fx_settlementsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payment_intents":{"post":{"operationId":"list_payment_intents","summary":"List crypto payment intents with requested amount, amount paid, settlement currency and status timeline. Use for \"Which ","description":"List crypto payment intents with requested amount, amount paid, settlement currency and status timeline. Use for \"Which Circle payment intents are underpaid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["created","pending","complete","expired","failed"],"type":"string"},{"type":"null"}],"default":null,"description":"Latest timeline status.","title":"Status"},"context":{"anyOf":[{"enum":["underpaid","paid","overpaid"],"type":"string"},{"type":"null"}],"default":null,"description":"Latest timeline context.","title":"Context"},"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_payment_intentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payments":{"post":{"operationId":"list_payments","summary":"List payments received (card and crypto) with amount, status, description and whether they were captured. Use for \"Show ","description":"List payments received (card and crypto) with amount, status, description and whether they were captured. Use for \"Show my latest Circle payments\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"from_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or after this ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only items created at or before this ISO 8601 date-time.","title":"To Time"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (at least 1; Circle may apply its own upper limit).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the last item of the previous page; returns the items after it. Do not combine with page_before.","title":"Page After"},"page_before":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the id of the first item of the current page; returns the items before it. Do not combine with page_after.","title":"Page Before"}},"title":"list_paymentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}