# Circle Docs: API reference Circle Payments Network > Developer documentation for Circle's developer tools > ## Agent Instructions > Before reading these docs, install the relevant Circle Skill to get pre-loaded context — skills are LLM-optimized and cover architecture decisions, correct flows, and common pitfalls. In Claude Code: run /plugin marketplace add circlefin/skills then /plugin install circle-skills@circle. With Vercel Skills CLI: run npx skills add circlefin/skills. Available skills: use-usdc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-usdc/SKILL.md (balances, transfers, approvals on EVM and Solana); EURC has no skill — see https://developers.circle.com/stablecoins/what-is-eurc.md; bridge-stablecoin https://github.com/circlefin/skills/blob/master/plugins/circle/skills/bridge-stablecoin/SKILL.md (crosschain transfers via CCTP, USDC, EURC, and third-party assets); use-arc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-arc/SKILL.md (Arc chain config, contract deployment, USDC bridging — Arc docs: https://docs.arc.io/llms.txt); use-circle-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-circle-wallets/SKILL.md (choose wallet type); use-developer-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-developer-controlled-wallets/SKILL.md (custodial wallets for payouts and treasury); use-user-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-user-controlled-wallets/SKILL.md (embedded wallets with Web2 login); use-modular-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-modular-wallets/SKILL.md (smart contract wallets with passkeys and ERC-4337); use-gateway https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-gateway/SKILL.md (unified USDC balance, nanopayments); use-smart-contract-platform https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-smart-contract-platform/SKILL.md (deploy, interact, monitor contracts). Pair any skill with the Circle MCP server for live SDK signatures, contract addresses, and chain IDs: {"mcpServers":{"circle":{"url":"https://api.circle.com/v1/codegen/mcp"}}}. > Read the product overview first. Each product has an overview explaining when and why to use it. Read it before quickstarts. > Pick the right wallet type. Developer-controlled (you hold keys), user-controlled (end user holds keys via PIN/social login), or modular (smart contract wallets with passkeys). See https://developers.circle.com/wallets.md. > Use CCTP V2 for crosschain transfers. CCTP natively transfers USDC and EURC via burn-and-mint, and supports permissionless wrapping of third-party assets via lock-and-mint. V1 is legacy; always use V2 unless V1 is specified or the chain requires it (Noble, Sui, and Aptos still require V1). Migration guide: https://developers.circle.com/cctp/migration-from-v1-to-v2.md. > Use Bridge Kit for frontend bridging. Wraps CCTP with a simpler SDK for user-facing apps. Use CCTP directly for backend transfers. > Gas Station vs Paymaster. Gas Station sponsors gas for Circle Wallet transactions. Paymaster lets users pay gas in USDC. Different use cases — read both overviews. > Gateway Nanopayments for sub-cent payments. Gasless USDC micropayments down to $0.000001 via x402 and batched settlement. For pay-per-request APIs, AI agent payments, streaming. > Look up USDC addresses per chain. Never hardcode — use https://developers.circle.com/stablecoins/usdc-contract-addresses.md. > Prefer SDKs over raw API calls. Node.js and Python SDKs handle auth, retries, and errors. > API key required. Bearer token in Authorization header. Testnet and mainnet use separate keys and may use different base URLs depending on the product. > Set up webhooks when available. Most operations are async. Webhooks deliver transaction confirmations and state changes. > When calling list endpoints, paginate using pageSize and pageAfter until no nextPageAfter cursor is returned—stopping at the first page silently misses records. > Building an AI agent? Start with the Agent Stack—Circle CLI, agent wallets, and nanopayments built for autonomous use cases: https://developers.circle.com/agent-stack.md. ## Circle Payments Network - [Circle Payments Network API](https://developers.circle.com/api-reference/cpn.md): Route and settle stablecoin payments across Circle's network with support for quotes, payments, transactions, and managed payments. - [Postman collection](https://developers.circle.com/api-reference/cpn/postman.md): Use Circle's Postman collection to send API requests and explore the Circle Payments Network APIs. - [Error codes](https://developers.circle.com/api-reference/cpn/error-codes.md): Descriptions of error codes returned by the CPN API. ### API overview #### Health - [Ping](https://developers.circle.com/api-reference/cpn/common/ping.md): Checks that the service is running. #### Webhook Subscriptions - [Get all webhook subscriptions](https://developers.circle.com/api-reference/cpn/common/get-subscriptions.md): Returns an array of existing webhook subscriptions. - [Create a webhook subscription](https://developers.circle.com/api-reference/cpn/common/create-subscription.md): Create a webhook subscription by configuring an endpoint to receive notifications. - [Get a notification subscription](https://developers.circle.com/api-reference/cpn/common/get-subscription.md): Returns an existing notification subscription. - [Update a notification subscription](https://developers.circle.com/api-reference/cpn/common/update-subscription.md): Update subscription endpoint to receive notifications. - [Delete a notification subscription](https://developers.circle.com/api-reference/cpn/common/delete-subscription.md): Delete an existing subscription. - [Get a notification signature public key](https://developers.circle.com/api-reference/cpn/common/get-notification-signature.md): Get the public key and algorithm used to digitally sign webhook notifications. Verifying the digital signature ensures the notification came from Circle. ### Fiat payouts #### Configurations - [Get payment configurations](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment-configurations-overview.md): Returns the overview of supported countries, currencies, payment methods, blockchains. - [Get supported payment routes](https://developers.circle.com/api-reference/cpn/cpn-platform/list-routes.md): Returns a list of route details including trade limits. This information can determine what corridors and parameters are valid for subsequent quote creation. - [Retrieve all ofi-enabled payment routes](https://developers.circle.com/api-reference/cpn/cpn-platform/list-ofi-enabled-routes.md): Retrieve all ofi-enabled payment routes. #### Quotes - [Create a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/create-quotes.md): Creates one or more quotes for the given source/destination parameters. Returns quotes sorted in the following order: - [Get details of a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/get-quote.md): Retrieve details of a specific quote (e.g., re-check expiration, fees). #### Payments - [List payments](https://developers.circle.com/api-reference/cpn/cpn-platform/list-payments.md): Returns a list of all payments that fit the specified parameters. - [Create a payment](https://developers.circle.com/api-reference/cpn/cpn-platform/create-payment.md): Creates a payment by using the quote created previously and submitting recipient information (travel rule). The payment will remain valid if the onchain settlement occurs before settlementExpireDate. - [Get payment requirements for a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment-requirements.md): Retrieves the PII fields needed to collect to make this payment (travel rule and beneficiary account data). - [Get a payment](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment.md): Returns the PII fields needed to collect to make this payment (i.e. travel rule and beneficiary account data) - [Get refund details](https://developers.circle.com/api-reference/cpn/cpn-platform/get-refund.md): Retrieves the full refund object associated with a specific payment. This can be used by OFIs to reconcile refund status and verify refund completion. #### Transactions - [Create a transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/create-transaction.md): Creates an unsigned onchain transaction for a specific payment. - [Get a transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/get-transaction.md): Retrieves a specific transaction by its ID for a given payment - [Submit a signed transaction for broadcast](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-transaction.md): Return the signed hex string of the transaction, Circle will validate the content and broadcast to the chain. - [Accelerate a stuck transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/accelerate-transaction.md): - Accelerate a transaction based on the payment ID. It should be used when a transaction associated with the payment is broadcasted but not confirmed for a long period of time (i.e 10 minutes). This is usually due to gas fees being too low and not picked up by any miner/validator. - [Create a transaction (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/create-transaction-v2.md): Create a V2 transaction for signing - [Get a transaction by ID (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/get-transaction-v2.md): Get a transaction by ID - [Submit a signed transaction for broadcast (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-transaction-v2.md): Submit a signed V2 transaction for broadcast #### Requests for information - [Get details for an RFI](https://developers.circle.com/api-reference/cpn/cpn-platform/get-rfi.md): Retrieve details of a specific RFI for a payment. If the BFI initiates an RFI after the payment is created, the OFI will be notified via webhook. This webhook will detail what specific information the OFI needs to send. - [Submit RFI data](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-rfi.md): Submit encrypted RFI data to complete an RFI request from the BFI. - [Upload RFI file](https://developers.circle.com/api-reference/cpn/cpn-platform/upload-rfi-file.md): Upload encrypted RFI file. #### Support tickets - [Create a support ticket](https://developers.circle.com/api-reference/cpn/cpn-platform/create-support-ticket.md): Create transaction-related issues (for example, settlement delays, missing information, or refunds). These tickets are stored centrally in the CPN platform and routed to the appropriate party for resolution. ### Managed Payments #### Accounts - [List all accounts](https://developers.circle.com/api-reference/cpn/managed-payments/accounts/list-accounts.md): Retrieves the accounts available to the calling entity. - [Create an account](https://developers.circle.com/api-reference/cpn/managed-payments/accounts/create-account.md): Creates a new account. This account can be used to create accounts for Mint, or intermediary accounts for a Managed Payments customer. For Managed Payments, the account created represents the end customer that will settle stablecoin payments by the customer. That end customer can be either a busines… - [Get an account](https://developers.circle.com/api-reference/cpn/managed-payments/accounts/get-account.md): Retrieves a single account by `accountId`. - [Archive an account](https://developers.circle.com/api-reference/cpn/managed-payments/accounts/archive-account.md): Archives a subledger account. Only subledger-type accounts (those created via `POST /v1/accounts`) may be archived, and the account must have a zero balance. #### Wires - [List all wire bank accounts](https://developers.circle.com/api-reference/cpn/managed-payments/wires/list-account-wire-accounts.md): Retrieves a list of bank accounts for wire transfers. - [Create a wire bank account](https://developers.circle.com/api-reference/cpn/managed-payments/wires/create-account-wire-account.md): Create a bank account for wire transfers. - [Get a wire bank account](https://developers.circle.com/api-reference/cpn/managed-payments/wires/get-account-wire-account.md): Retrieves a specific wire bank account. - [Get wire instructions](https://developers.circle.com/api-reference/cpn/managed-payments/wires/get-account-wire-account-instructions.md): Retrieves wire transfer instructions for a specific bank account. #### Deposits - [List all account bank deposits](https://developers.circle.com/api-reference/cpn/managed-payments/deposits/list-account-deposits.md): Searches for bank deposits sent to accounts. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. - [Get an account bank deposit](https://developers.circle.com/api-reference/cpn/managed-payments/deposits/get-account-deposit.md): Returns a bank deposit by ID. #### Withdrawals - [Create an account bank withdrawal](https://developers.circle.com/api-reference/cpn/managed-payments/withdrawals/create-account-withdrawal.md): Create a bank withdrawal from an account. This converts a digital asset to fiat currency and sends it to the specified destination bank account. - [List all account bank withdrawals](https://developers.circle.com/api-reference/cpn/managed-payments/withdrawals/list-account-withdrawals.md): Lists all bank withdrawals for accounts. - [Get an account bank withdrawal](https://developers.circle.com/api-reference/cpn/managed-payments/withdrawals/get-account-withdrawal.md): Retrieves a specific bank withdrawal. #### Internal transfers - [Create an account transfer](https://developers.circle.com/api-reference/cpn/managed-payments/transfers/create-account-transfer.md): Create an internal transfer from an account to another account under the same parent. Supported paths are subaccount to subaccount, main wallet to subaccount, and subaccount to main wallet. Cross-parent transfers are rejected. - [List all account transfers](https://developers.circle.com/api-reference/cpn/managed-payments/transfers/list-account-transfers.md): Searches for all money movement recorded against your accounts. Results include internal account-to-account transfers, onchain deposits, and onchain withdrawals. Use the `source` and `destination` fields on each transfer to determine directionality: onchain deposits appear with a blockchain source a… - [Get an account transfer](https://developers.circle.com/api-reference/cpn/managed-payments/transfers/get-account-transfer.md): Retrieves a specific transfer. For onchain activity, outbound transfers typically appear with an account source and blockchain destination, while inbound transfers typically appear with a blockchain source and account destination. #### Credit - [Borrow against line of credit](https://developers.circle.com/api-reference/cpn/managed-payments/credit/create-managed-payments-credit-transfer.md): Initiates a transfer (borrowing) against the line of credit. - [Get credit line details](https://developers.circle.com/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-line.md): Retrieves the details of the Managed Payments credit line. - [Get a credit transfer](https://developers.circle.com/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-transfer.md): Returns detailed information about a specific credit transfer. - [List credit transfers](https://developers.circle.com/api-reference/cpn/managed-payments/credit/list-managed-payments-credit-transfers.md): Returns a list of credit transfers for the specified credit line. Filterable by status and date range. - [Get repayment wire instructions](https://developers.circle.com/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-wire-instructions.md): Fetches the necessary wire transfer instructions for repaying funds borrowed against the line of credit. #### Stablecoin payins ##### Payment intents - [List all payment intents](https://developers.circle.com/api-reference/cpn/managed-payments/payment-intents/list-payment-intents.md) - [Create a payment intent](https://developers.circle.com/api-reference/cpn/managed-payments/payment-intents/create-payment-intent.md): Create a continuous (default) or transient payment intent. Continuous payment intents are created by default. To create a transient payment intent, the `type` field must be explicitly set to `transient`. - [Get a payment intent](https://developers.circle.com/api-reference/cpn/managed-payments/payment-intents/get-payment-intent.md) - [Expire a payment intent](https://developers.circle.com/api-reference/cpn/managed-payments/payment-intents/expire-payment-intent.md) - [Refund a payment intent](https://developers.circle.com/api-reference/cpn/managed-payments/payment-intents/refund-payment-intent.md) ##### Payments - [List all payments](https://developers.circle.com/api-reference/cpn/managed-payments/payments/list-payments.md) - [Get a payment](https://developers.circle.com/api-reference/cpn/managed-payments/payments/get-payment.md) ##### Refund addresses - [Create a crypto payment refund address](https://developers.circle.com/api-reference/cpn/managed-payments/refund-addresses/create-payment-refund-address.md): Creates a refund address-book entry that can be used as `destination.addressBookId` when refunding a crypto payment intent. #### Stablecoin payouts ##### Address book - [List all recipients](https://developers.circle.com/api-reference/cpn/managed-payments/address-book/list-address-book-recipients.md) - [Create a recipient](https://developers.circle.com/api-reference/cpn/managed-payments/address-book/create-address-book-recipient.md): Creates an address book recipient. Required fields depend on your Circle entity; use the request body options that match your integration. - [Get a recipient](https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient.md) - [Modify a recipient](https://developers.circle.com/api-reference/cpn/managed-payments/address-book/modify-address-book-recipient.md): Updates address book recipient metadata. - [Delete a recipient](https://developers.circle.com/api-reference/cpn/managed-payments/address-book/delete-address-book-recipient.md) ##### Payouts - [List all payouts](https://developers.circle.com/api-reference/cpn/managed-payments/payouts/list-payouts.md) - [Create a payout](https://developers.circle.com/api-reference/cpn/managed-payments/payouts/create-payout.md): Create a stablecoin payout. - [Get a payout](https://developers.circle.com/api-reference/cpn/managed-payments/payouts/get-payout.md) #### Reporting - [List reports](https://developers.circle.com/api-reference/circle-mint/account/list-reports.md): Returns a paginated list of the account's previously generated reports for a given report type and date range, each with a pre-signed `downloadUrl`. Listable report types: `managed_payout_transactions`, `managed_payment_wallet_balances`, `managed_payin_transactions`, `camt_managed`, `camt053`, `camt… - [Request a report](https://developers.circle.com/api-reference/circle-mint/account/request-report.md): Submits a report generation request. `reportType` specifies the type of report and required fields. Supported report types: `camt053`, `camt_managed`, `managed_payout_transactions`, `managed_payment_wallet_balances`, and `managed_payin_transactions`. The managed-payment reports take a `timeframe` fi… - [Get report by ID](https://developers.circle.com/api-reference/circle-mint/account/get-report-by-id.md): Returns the current metadata for a report, including a fresh pre-signed `downloadUrl` when the report is `ready`. Use this endpoint to check the status of a `pending` report or to obtain a new download URL after the previous one has expired. - [Download report content](https://developers.circle.com/api-reference/circle-mint/account/get-report-content.md): Streams the raw report content as a file download, an alternative to following `downloadUrl` from the JSON response. Returns `409` if the report is not yet `ready`. #### Webhooks - [Transfer state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/custody-transfer.md): Sent when a stablecoin transfer changes state. A `wallet` destination is an internal transfer between subaccounts. A blockchain destination is an outbound crypto transfer. `status` is one of `pending`, `complete`, or `failed`. - [Payment intent state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-payment-intents.md): Sent when a payment intent is created, receives a deposit address, or receives funds. `status` is one of `created`, `pending`, `active`, `complete`, `expired`, `failed`, or `refunded`. One-time intents use `pending` while awaiting a deposit; continuous intents use `active` once a deposit address is… - [Payment state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-payments.md): Sent when a payment changes state. `status` is one of `pending`, `action_required`, `confirmed`, `paid`, `failed`, or `reversed`. `paid` and `failed` are terminal. - [Deposit state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-deposits.md): Sent when a fiat deposit into a subaccount changes state. `status` is one of `pending`, `complete`, or `failed`. - [Payout terminal state](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-payout.md): Sent when a withdrawal to a bank account reaches a terminal state. `status` is `complete` or `failed`. Not sent for the intermediate `pending` state. - [Wire state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-wire.md): Sent when a wire transfer changes state. `status` is one of `pending`, `complete`, or `failed`. - [Recipient address state change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-address-book-recipients.md): Sent when a recipient address changes state, most often as it moves through verification. `status` is one of `pending`, `pending_verification`, `pending_additional_information`, `pending_owner_information`, `pending_beneficiary_information`, `denied`, `inactive`, `verification_succeeded`, `active`,… - [Subaccount status change](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-accounts.md): Sent when a subaccount changes status. `status` is one of `pending`, `active`, `rejected`, `archived`, or `closed`. `type` is `first_party` or `third_party`, and `purpose` is `payments` or `custody`. - [External entity compliance decision](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/mint-external-entities.md): Sent when an external entity reaches a compliance decision. `complianceState` is one of `PENDING`, `ACCEPTED`, or `REJECTED`. Wait for `ACCEPTED` before transacting on behalf of the entity. - [Application approved](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/onboarding-application-approved.md): Sent when an end customer application is approved. The end customer can now transact. - [Application denied](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/onboarding-application-denied.md): Sent when an end customer application is denied. The end customer cannot transact, and the decision is final. - [Application cancelled](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/onboarding-application-cancelled.md): Sent when an end customer application is cancelled before reaching a decision. `previousStatus` reports the stage it was cancelled from, either `DRAFT` or `IN_REVIEW`. - [Information requested](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/onboarding-application-rfi-requested.md): Sent when Circle needs more information before it can decide. The application moves to `PENDING_CUSTOMER_INFORMATION` from review, and stays there until the end customer supplies what was requested. - [Periodic review requested](https://developers.circle.com/api-reference/cpn/managed-payments/webhooks/onboarding-periodic-review-requested.md): Sent when a periodic review opens for an approved end customer. The review starts as a new application in `DRAFT`, so the end customer must complete it to stay in good standing. ### Stablecoin payments #### Stablecoin payins ##### Payments - [List all payments](https://developers.circle.com/api-reference/circle-mint/payments/list-payments.md) - [Get a payment](https://developers.circle.com/api-reference/circle-mint/payments/get-payment.md) ##### Payment intents - [List all payment intents](https://developers.circle.com/api-reference/circle-mint/payments/list-payment-intents.md) - [Create a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-intent.md): Create a continuous (default) or transient payment intent. Continuous payment intents are created by default. To create a transient payment intent, the `type` field must be explicitly set to `transient`. - [Get a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/get-payment-intent.md) - [Expire a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/expire-payment-intent.md) - [Refund a payment intent](https://developers.circle.com/api-reference/circle-mint/payments/refund-payment-intent.md) ##### Crypto Payment Refund Addresses - [Create a crypto payment refund address](https://developers.circle.com/api-reference/circle-mint/payments/create-payment-refund-address.md): Creates a refund address-book entry that can be used as `destination.addressBookId` when refunding a crypto payment intent. #### Stablecoin payouts ##### Payouts - [List all payouts](https://developers.circle.com/api-reference/circle-mint/payouts/list-payouts.md) - [Create a payout](https://developers.circle.com/api-reference/circle-mint/payouts/create-payout.md): Create a stablecoin payout. - [Get a payout](https://developers.circle.com/api-reference/circle-mint/payouts/get-payout.md) ##### Address book - [List all recipients](https://developers.circle.com/api-reference/circle-mint/payouts/list-address-book-recipients.md) - [Create a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/create-address-book-recipient.md): Creates an address book recipient. Required fields depend on your Circle entity; use the request body options that match your integration. - [Get a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/get-address-book-recipient.md) - [Modify a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/modify-address-book-recipient.md): Updates address book recipient metadata. - [Delete a recipient](https://developers.circle.com/api-reference/circle-mint/payouts/delete-address-book-recipient.md) - [List VASPs](https://developers.circle.com/api-reference/circle-mint/payouts/list-address-book-vasps.md): Returns active Virtual Asset Service Providers (VASPs) available for the customer's jurisdiction. Use returned `id` values as `vaspId` in `ownership.custody` when creating a recipient and custody is `hosted`. ### Circle Payments Network #### Configurations - [Get payment configurations](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment-configurations-overview.md): Returns the overview of supported countries, currencies, payment methods, blockchains. - [Get supported payment routes](https://developers.circle.com/api-reference/cpn/cpn-platform/list-routes.md): Returns a list of route details including trade limits. This information can determine what corridors and parameters are valid for subsequent quote creation. - [Retrieve all ofi-enabled payment routes](https://developers.circle.com/api-reference/cpn/cpn-platform/list-ofi-enabled-routes.md): Retrieve all ofi-enabled payment routes. #### Quotes - [Create a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/create-quotes.md): Creates one or more quotes for the given source/destination parameters. Returns quotes sorted in the following order: - [Get details of a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/get-quote.md): Retrieve details of a specific quote (e.g., re-check expiration, fees). #### Payments - [List payments](https://developers.circle.com/api-reference/cpn/cpn-platform/list-payments.md): Returns a list of all payments that fit the specified parameters. - [Create a payment](https://developers.circle.com/api-reference/cpn/cpn-platform/create-payment.md): Creates a payment by using the quote created previously and submitting recipient information (travel rule). The payment will remain valid if the onchain settlement occurs before settlementExpireDate. - [Get payment requirements for a quote](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment-requirements.md): Retrieves the PII fields needed to collect to make this payment (travel rule and beneficiary account data). - [Get a payment](https://developers.circle.com/api-reference/cpn/cpn-platform/get-payment.md): Returns the PII fields needed to collect to make this payment (i.e. travel rule and beneficiary account data) - [Get refund details](https://developers.circle.com/api-reference/cpn/cpn-platform/get-refund.md): Retrieves the full refund object associated with a specific payment. This can be used by OFIs to reconcile refund status and verify refund completion. #### Transactions - [Create a transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/create-transaction.md): Creates an unsigned onchain transaction for a specific payment. - [Get a transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/get-transaction.md): Retrieves a specific transaction by its ID for a given payment - [Submit a signed transaction for broadcast](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-transaction.md): Return the signed hex string of the transaction, Circle will validate the content and broadcast to the chain. - [Accelerate a stuck transaction](https://developers.circle.com/api-reference/cpn/cpn-platform/accelerate-transaction.md): - Accelerate a transaction based on the payment ID. It should be used when a transaction associated with the payment is broadcasted but not confirmed for a long period of time (i.e 10 minutes). This is usually due to gas fees being too low and not picked up by any miner/validator. - [Create a transaction (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/create-transaction-v2.md): Create a V2 transaction for signing - [Get a transaction by ID (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/get-transaction-v2.md): Get a transaction by ID - [Submit a signed transaction for broadcast (V2)](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-transaction-v2.md): Submit a signed V2 transaction for broadcast #### Requests for Information - [Get details for an RFI](https://developers.circle.com/api-reference/cpn/cpn-platform/get-rfi.md): Retrieve details of a specific RFI for a payment. If the BFI initiates an RFI after the payment is created, the OFI will be notified via webhook. This webhook will detail what specific information the OFI needs to send. - [Submit RFI data](https://developers.circle.com/api-reference/cpn/cpn-platform/submit-rfi.md): Submit encrypted RFI data to complete an RFI request from the BFI. - [Upload RFI file](https://developers.circle.com/api-reference/cpn/cpn-platform/upload-rfi-file.md): Upload encrypted RFI file. #### Support Tickets - [Create a support ticket](https://developers.circle.com/api-reference/cpn/cpn-platform/create-support-ticket.md): Create transaction-related issues (for example, settlement delays, missing information, or refunds). These tickets are stored centrally in the CPN platform and routed to the appropriate party for resolution. ## OpenAPI Specs - [configurations](/openapi/configurations.yaml) - [cpn-ofi](/openapi/cpn-ofi.yaml) - [accounts](/openapi/accounts.yaml) - [managed-payments](/openapi/managed-payments.yaml) - [payments](/openapi/payments.yaml) - [payouts](/openapi/payouts.yaml) - [account](/openapi/account.yaml) - [managed-payments-webhooks](/openapi/managed-payments-webhooks.yaml)