bitpro가 원문에서 글자만 모은 내용이에요. 표·그림·수식은 빠지거나 깨질 수 있어요. 전체 75쪽 중 7쪽
Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.
**cirBTC deposits on the BTC chain:** Requesting a deposit address with `currency=CIRBTC` and `chain=BTC` returns a native Bitcoin (BTC) address. Bitcoin sent to that address is automatically wrapped and credited to the associated wallet as `CIRBTC` (1:1). The returned address itself is a standard BTC address, only the resulting wallet balance is denominated in cirBTC.
Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
# Create a payout
Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-payout
openapi/account.yaml post /v1/businessAccount/payouts
Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency.
# Create a PIX bank account
Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-pix-account
openapi/account.yaml post /v1/businessAccount/banks/pix
# Create a recipient address
Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-recipient-address
openapi/account.yaml post /v1/businessAccount/wallets/addresses/recipient
Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
**cirBTC recipients:** Recipient addresses for cirBTC flows are registered with one of these `chain` and `currency` pairs:
- `chain=ETH` with `currency=CIRBTC` for onchain cirBTC transfers.
- `chain=BTC` with `currency=BTC` for native Bitcoin recipients. To redeem cirBTC to native Bitcoin, create a transfer with `amount.currency=CIRBTC` to a recipient of this form; Circle will burn the cirBTC and release the equivalent amount of native Bitcoin (1:1) to the Bitcoin address.
**For France customers:**
Circle Mint France customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status. Please see Help Center articles below for details:
- [Circle Mint France Travel Rule](https://help.circle.com/s/article/Circle-Mint-France-Travel-Rule)
- [Circle Mint France wallet verification](https://help.circle.com/s/article/Circle-Mint-France-wallet-verification)
# Create a transfer
Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-transfer
openapi/account.yaml post /v1/businessAccount/transfers
A transfer can be made from an existing business account to a blockchain location.
**cirBTC transfers:** When `amount.currency=CIRBTC`, the recipient's `chain` (looked up from `destination.addressId`) determines how the transfer is processed:
- Recipients on `chain=ETH` receive an onchain cirBTC transfer.
- Recipients on `chain=BTC` trigger redemption to native Bitcoin: the cirBTC is burned and an equivalent amount of native Bitcoin (1:1) is released to the Bitcoin address.
# Create a wire bank account
Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-wire-account
openapi/account.yaml post /v1/businessAccount/banks/wires
# Create a mock Wire payment
Source: https://developers.circle.com/api-reference/circle-mint/account/create-mock-wire-payment
openapi/account.yaml post /v1/mocks/payments/wire
In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet.
# Delete a recipient address
Source: https://developers.circle.com/api-reference/circle-mint/account/delete-business-recipient-address
openapi/account.yaml delete /v1/businessAccount/wallets/addresses/recipient/{id}
Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.
# Get associated accounts
Source: https://developers.circle.com/api-reference/circle-mint/account/get-associated-accounts
openapi/account.yaml get /v1/businessAccount/associatedAccounts
Returns a list of sibling CMAs that are associated with the current account under unified credentials. These accounts can be used as destinations for cross-entity transfers.
# Get a CUBIX bank account
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-cubix-account
openapi/account.yaml get /v1/businessAccount/banks/cubix/{id}
# Get CUBIX instructions
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-cubix-account-instructions
openapi/account.yaml get /v1/businessAccount/banks/cubix/{id}/instructions
Get the CUBIX transfer instructions into the Circle bank account given your fiat account id.
# List all deposit addresses
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-deposit-address
openapi/account.yaml get /v1/businessAccount/wallets/addresses/deposit
Returns a list of deposit addresses for a given wallet.
# Get a deposit by ID
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-deposit-by-id
openapi/account.yaml get /v1/businessAccount/deposits/{id}
Returns a deposit by ID.
# Get a payout
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-payout
openapi/account.yaml get /v1/businessAccount/payouts/{id}
# Get a PIX bank account
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-pix-account
openapi/account.yaml get /v1/businessAccount/banks/pix/{id}
# Get PIX instructions
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-pix-account-instructions
openapi/account.yaml get /v1/businessAccount/banks/pix/{id}/instructions
Get the PIX transfer instructions into the Circle bank account given your bank account id.
# Get a transfer
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-transfer
openapi/account.yaml get /v1/businessAccount/transfers/{id}
# Get a wire bank account
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-wire-account
openapi/account.yaml get /v1/businessAccount/banks/wires/{id}
# Get wire instructions
Source: https://developers.circle.com/api-reference/circle-mint/account/get-business-wire-account-instructions
openapi/account.yaml get /v1/businessAccount/banks/wires/{id}/instructions
Get the wire transfer instructions into the Circle bank account given your bank account ID.
# Get PIX routing info
Source: https://developers.circle.com/api-reference/circle-mint/account/get-pix-routing-info
openapi/account.yaml get /v1/businessAccount/banks/pix/{fiatAccountId}/routingInfo
Retrieves available settlement banks and current routing configuration for a PIX fiat account.
# Get report by ID
Source: https://developers.circle.com/api-reference/circle-mint/account/get-report-by-id
openapi/account.yaml get /v1/reports/{id}
Returns the current metadata for a report, including a fresh pre-signed `downloadUrl` when the report is `ready`.
Use this endpoint to check the status of a `pending` report or to obtain a new download URL after the previous one has expired.
# Download report content
Source: https://developers.circle.com/api-reference/circle-mint/account/get-report-content
openapi/account.yaml get /v1/reports/{id}/content
Streams the raw report content as a file download, an alternative to following `downloadUrl` from the JSON response.
Returns `409` if the report is not yet `ready`.
# Get wire routing info
Source: https://developers.circle.com/api-reference/circle-mint/account/get-wire-routing-info
openapi/account.yaml get /v1/businessAccount/banks/wires/{fiatAccountId}/routingInfo
Retrieves available settlement banks and current routing configuration for a wire fiat account.
# List all balances
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-balances
openapi/account.yaml get /v1/businessAccount/balances
Retrieves the balance of funds that are available for use.
# List all CUBIX bank accounts.
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-cubix-accounts
openapi/account.yaml get /v1/businessAccount/banks/cubix
# List fiat deposits
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-deposits
openapi/account.yaml get /v1/businessAccount/deposits
Searches for wire and other fiat deposits sent to your business account. Onchain (crypto) deposits do not appear on this endpoint; use `GET /v1/transfers` to retrieve onchain deposits. If the date parameters are omitted, the endpoint returns the most recent deposits. It returns up to 50 deposits in descending chronological order or `pageSize`, if provided.
# List all payouts
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-payouts
openapi/account.yaml get /v1/businessAccount/payouts
Lists all payouts for your account.
Note that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID.
# List all PIX bank accounts.
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-pix-accounts
openapi/account.yaml get /v1/businessAccount/banks/pix
# List all recipient addresses
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-recipient-addresses
openapi/account.yaml get /v1/businessAccount/wallets/addresses/recipient
Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.
# List recipient VASPs
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-recipient-vasps
openapi/account.yaml get /v1/businessAccount/wallets/addresses/vasps
Returns the Virtual Asset Service Providers (VASPs) available to the caller. Use a returned `id` as `vaspId` in `ownership.custody` when creating a recipient and custody is `hosted`.
Pass `clientEntityId` to list the VASPs of a specific client entity; the caller must be that client entity's parent.
# List all transfers
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-transfers
openapi/account.yaml get /v1/businessAccount/transfers
Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided.
# List all wire bank accounts
Source: https://developers.circle.com/api-reference/circle-mint/account/list-business-wire-accounts
openapi/account.yaml get /v1/businessAccount/banks/wires
# List burn fee calculations
Source: https://developers.circle.com/api-reference/circle-mint/account/list-net-burn-fee-daily-calculations
openapi/account.yaml get /v1/fees/redemption/dailyReports
Returns burn fee calculations, including daily records and surcharges. Returns up to 50 calculations in descending chronological order, or `pageSize` results if specified.
# List reports
Source: https://developers.circle.com/api-reference/circle-mint/account/list-reports
openapi/account.yaml get /v1/reports
Returns a paginated list of the account's previously generated reports for a given report type and date range, each with a pre-signed `downloadUrl`.
Listable report types: `managed_payout_transactions`, `managed_payment_wallet_balances`, `managed_payin_transactions`, `camt_managed`, `camt053`, `camt052`, and `daily_statement_csv`.
Note: `camt052` reports are generated on demand, so a `camt052` request returns only the dates previously requested with `POST /v1/reports`. A date that was never requested is absent from the list.
Note: the `id` of each listed report is a storage object key, not the deterministic report UUID. It cannot be passed to `GET /v1/reports/{id}` or `GET /v1/reports/{id}/content`; download a listed report using its `downloadUrl`.
# Request a report
Source: https://developers.circle.com/api-reference/circle-mint/account/request-report
openapi/account.yaml post /v1/reports
Submits a report generation request. `reportType` specifies the type of report and required fields.
Supported report types: `camt053`, `camt_managed`, `managed_payout_transactions`, `managed_payment_wallet_balances`, and `managed_payin_transactions`. The managed-payment reports take a `timeframe` field (`daily` or `monthly`); `camt_managed` and `managed_payment_wallet_balances` support `daily` only.
If ready, returns `200` with a pre-signed `downloadUrl`. If not, returns `202` with status `pending`. Poll `GET /v1/reports/{id}` for status, or download using `GET /v1/reports/{id}/content` when ready.
Requests are idempotent: the same entity and request parameters always produce the same report ID. Retries return the existing report. `camt053` reports are only returned for accounts with activity in the preceding 365 days.
`camt_managed` reports are only generated for dates with managed payment activity. Requesting a date with no activity returns `400` (`{"code":2,"message":"API parameter invalid"}`), the same response as a malformed request. To discover which dates have reports before calling this endpoint, use `GET /v1/reports?reportType=camt_managed&startDate=<start>&endDate=<end>`.
# Update PIX routing preferences
Source: https://developers.circle.com/api-reference/circle-mint/account/update-pix-routing-preferences
openapi/account.yaml put /v1/businessAccount/banks/pix/{fiatAccountId}/routingPreferences
Creates or updates the settlement bank routing preferences for a PIX fiat account.
At least one of `inboundBankLabel` or `outboundBankLabel` must be provided in the request.
Note: This endpoint will reject updates if the account has active Express routes configured. Accounts with Express routes must update preferences through the Circle Mint UI.
# Update wire routing preferences
Source: https://developers.circle.com/api-reference/circle-mint/account/update-wire-routing-preferences
openapi/account.yaml put /v1/businessAccount/banks/wires/{fiatAccountId}/routingPreferences
Creates or updates the settlement bank routing preferences for a wire fiat account.
At least one of `inboundBankLabel` or `outboundBankLabel` must be provided in the request.
Note: This endpoint will reject updates if the account has active Express routes configured. Accounts with Express routes must update preferences through the Circle Mint UI.
# Cancel reserved funds
Source: https://developers.circle.com/api-reference/circle-mint/credit/cancel-credit-transfer-reserve
openapi/credit.yaml put /v1/credit/transfers/{id}/cancelReserve
Cancels a `funds_reserved` transfer and releases the reserved amount back to available credit.
The transfer must be in `funds_reserved` status for this operation.
**Note:** This endpoint is only available for Settlement Advance products.
# Initiate a crypto repayment
Source: https://developers.circle.com/api-reference/circle-mint/credit/create-credit-crypto-repayment
openapi/credit.yaml post /v1/credit/cryptoRepayment
Initiates a crypto repayment for a credit transfer.
The requested amount is capped at the outstanding balance. If the minimum of the requested amount and outstanding balance is zero, the request will be rejected with HTTP 400.
**Note:** This endpoint is only available for Line of Credit products. Crypto repayment is not supported for Settlement Advance products.
# Create a credit transfer
Source: https://developers.circle.com/api-reference/circle-mint/credit/create-credit-transfer
openapi/credit.yaml post /v1/credit/transfers
Requests a new credit transfer (drawdown) from the credit line. Disbursement is asynchronous.
**Note:** This endpoint is only available for Line of Credit products. Settlement Advance products must use the reserve funds flow.
# Create a mock wire repayment
Source: https://developers.circle.com/api-reference/circle-mint/credit/create-mock-wire-repayment
openapi/credit.yaml post /v1/credit/mocks/repayments
In the sandbox environment, initiate a mock wire repayment that simulates an incoming wire payment to repay an outstanding credit transfer. The fiat account will be automatically linked as a repayment account if not already linked.
# Get a credit fee
Source: https://developers.circle.com/api-reference/circle-mint/credit/get-credit-fee
openapi/credit.yaml get /v1/credit/fees/{id}
Returns detailed information about a specific fee.
# Get credit line details
Source: https://developers.circle.com/api-reference/circle-mint/credit/get-credit-line
openapi/credit.yaml get /v1/credit
Provides overall credit line details, including status, available limit, and outstanding balance.
# Get a credit repayment
Source: https://developers.circle.com/api-reference/circle-mint/credit/get-credit-repayment
openapi/credit.yaml get /v1/credit/repayments/{id}
Returns detailed information about a specific repayment.
# Get a credit transfer
Source: https://developers.circle.com/api-reference/circle-mint/credit/get-credit-transfer
openapi/credit.yaml get /v1/credit/transfers/{id}
Returns detailed information about a specific credit transfer.
Fields `outstanding`, `fees`, `dueDate`, and `disbursedDate` are only present once the transfer reaches `disbursed`, `paid`, or `past_due` status.
# Get repayment account details
Source: https://developers.circle.com/api-reference/circle-mint/credit/get-repayment-account-detail
openapi/credit.yaml get /v1/credit/repaymentAccounts/{fiatAccountId}
Returns repayment account details and wire instructions for making a credit repayment using the specified fiat account.
# List all credit fees
Source: https://developers.circle.com/api-reference/circle-mint/credit/list-credit-fees
openapi/credit.yaml get /v1/credit/fees
Returns a paginated list of all historical fees. Filterable by create date range, currency, and status.
# List all credit repayments
Source: https://developers.circle.com/api-reference/circle-mint/credit/list-credit-repayments
openapi/credit.yaml get /v1/credit/repayments
Returns a paginated list of all repayments (fiat and crypto). Filterable by create date range, transfer ID, type, and status.
# List all credit transfers
Source: https://developers.circle.com/api-reference/circle-mint/credit/list-credit-transfers
openapi/credit.yaml get /v1/credit/transfers
Returns a paginated list of all credit transfers. Filterable by create date range and status. Transfer items in list responses do not include outstanding and fees properties.
# Request reserved funds
Source: https://developers.circle.com/api-reference/circle-mint/credit/request-credit-transfer-reserved-funds
openapi/credit.yaml put /v1/credit/transfers/{id}/requestReservedFunds
Transitions a `funds_reserved` transfer to `requested` status by uploading evidence (wire proof). This initiates the manual approval process for Settlement Advance transfers.
The request must include an evidence file (wire proof) as multipart form data. Allowed file types are `application/pdf`, `image/jpeg`, and `image/png`.
**Note:** This endpoint is only available for Settlement Advance products.
# Reserve funds for a credit transfer
Source: https://developers.circle.com/api-reference/circle-mint/credit/reserve-credit-transfer-funds
openapi/credit.yaml post /v1/credit/transfers/reserveFunds
Reserves funds for a Settlement Advance draw. This is the first mandatory step in the Settlement Advance transfer flow.
Reserved funds expire after 30 minutes if not progressed to `requested` status via the reque프로젝트로 돌아가기
