> ## Documentation Index > Fetch the complete documentation index at: https://developers.circle.com/llms.txt > Use this file to discover all available pages before exploring further. > ## 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. # Get a payout ## OpenAPI ````yaml openapi/payouts.yaml get /v1/payouts/{id} openapi: 3.0.2 info: version: ${version} title: Crypto Payouts API description: >- The Circle Payouts API allows you to programmatically make fast, global payouts to your customers, vendors, and suppliers. Make payouts on supported blockchains. servers: - url: https://api-sandbox.circle.com - url: https://api.circle.com security: [] tags: - name: Payouts description: Create and get information on address book payouts. - name: Crypto Address Book description: Manage blockchain addresses with metadata. paths: /v1/payouts/{id}: get: tags: - Payouts summary: Get a payout operationId: getPayout parameters: - $ref: '#/components/parameters/IdPath' responses: '200': description: Successfully retrieved a payout. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: title: GetPayoutResponse properties: data: allOf: - $ref: '#/components/schemas/CryptoPayoutResponseData' - type: object properties: externalRef: type: string nullable: true description: >- Onchain transaction hash for the payout. Present once the transaction has been broadcast to the network. example: >- 0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906 examples: Crypto Payout: value: data: id: b8627ae8-732b-4d25-b947-1df8f4007a29 sourceWalletId: '53535335' destination: type: address_book id: b8627ae8-732b-4d25-b947-1df8f4007a29 amount: amount: '3.14' currency: USD toAmount: amount: '3.14' currency: ETH fees: amount: '3.14' currency: USD networkFees: amount: '0.14' currency: USD purposeOfTransfer: PMT001 customerExternalRef: customer-ref-123 status: pending errorCode: transaction_denied riskEvaluation: decision: denied reason: '4000' externalRef: >- 0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906 createDate: '2020-04-10T02:13:30.000Z' updateDate: '2020-04-10T02:13:30.000Z' '401': $ref: '#/components/responses/NotAuthorized' '404': $ref: '#/components/responses/NotFound' security: - bearerAuth: [] components: parameters: IdPath: name: id description: Universally unique identifier (UUID v4) of a resource. in: path required: true schema: type: string format: uuid example: b3d9d2d5-4c12-4946-a09d-953e82fae2b0 headers: XRequestId: description: >- Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support. schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde schemas: CryptoPayoutResponseData: description: > Payout resource returned by create and get operations. Includes `purposeOfTransfer` when it was provided at create time (required for CIRCLE_SG entities). allOf: - $ref: '#/components/schemas/CryptoPayoutResponseGeneral' - type: object properties: purposeOfTransfer: $ref: '#/components/schemas/CryptoPayoutPurposeOfTransfer' CryptoPayoutResponseGeneral: type: object properties: id: $ref: '#/components/schemas/Id' sourceWalletId: type: string description: The identifier of the source wallet used to fund a payout. example: '53535335' destination: $ref: '#/components/schemas/CryptoPayoutDestination' amount: $ref: '#/components/schemas/PayoutMoney' toAmount: $ref: '#/components/schemas/PayoutMoney' fees: $ref: '#/components/schemas/PayoutMoney' networkFees: $ref: '#/components/schemas/PayoutMoney' customerExternalRef: $ref: '#/components/schemas/CustomerExternalRef' description: Customer-supplied reference to reconcile transactions. status: $ref: '#/components/schemas/PayoutStatus' errorCode: $ref: '#/components/schemas/PayoutErrorCode' riskEvaluation: $ref: '#/components/schemas/RiskEvaluation' createDate: $ref: '#/components/schemas/UtcTimestamp' updateDate: $ref: '#/components/schemas/UtcTimestamp' CryptoPayoutPurposeOfTransfer: type: string description: > Payment reason code for the payout. Aligned with Circle payment reason codes for Crypto Payouts. Do not use `PMT006`. See [Crypto Payouts payment reason codes](https://developers.circle.com/circle-mint/crypto-payouts-payment-reason-codes). Invalid values can return error code `5020`. enum: - PMT000 - PMT001 - PMT002 - PMT003 - PMT004 - PMT005 - PMT007 - PMT008 - PMT009 - PMT010 - PMT011 - PMT012 - PMT013 - PMT014 - PMT015 - PMT016 - PMT017 - PMT018 - PMT019 - PMT020 - PMT021 - PMT022 - PMT023 - PMT024 - PMT025 - PMT026 - PMT027 - PMT028 - PMT029 - PMT030 example: PMT001 Id: type: string description: Unique system generated identifier for the entity. format: uuid example: b8627ae8-732b-4d25-b947-1df8f4007a29 CryptoPayoutDestination: type: object description: The destination. required: - type - id properties: type: $ref: '#/components/schemas/CryptoPayoutDestinationType' id: $ref: '#/components/schemas/Id' PayoutMoney: type: object required: - amount - currency properties: amount: type: string description: Magnitude of the amount, in units of the currency, with a `.`. example: '3.14' currency: type: string description: ISO 4217 alpha-3 currency code for the amount. pattern: ^[A-Z]{3}$ example: USD CustomerExternalRef: type: string description: A customer-supplied reference for reconciliation purposes. pattern: ^[A-Za-z0-9-]{1,21}$ example: INV-2024-001234 PayoutStatus: type: string description: >- Status of the payout. Status `pending` indicates that the payout is in process; `complete` indicates it finished successfully; `failed` indicates it failed. enum: - pending - complete - failed PayoutErrorCode: type: string nullable: true description: >- Indicates the failure reason of a payout. Only present for payouts in failed state. Possible values are [`insufficient_funds`, `transaction_denied`, `transaction_failed`, `transaction_returned`, `bank_transaction_error`, `fiat_account_limit_exceeded`, `invalid_bank_account_number`, `invalid_ach_rtn`, `invalid_wire_rtn`, `vendor_inactive`]' enum: - insufficient_funds - transaction_denied - transaction_failed - transaction_returned - bank_transaction_error - fiat_account_limit_exceeded - invalid_bank_account_number - invalid_ach_rtn - invalid_wire_rtn - vendor_inactive RiskEvaluation: type: object description: >- Results of risk evaluation. Present when the payment's risk decision is `denied` or `review`. Absent when `decision` is `approved` or when no risk evaluation was performed. nullable: true properties: decision: description: Enumerated decision of the account. type: string enum: - approved - denied - review reason: description: >- Risk reason code for the decision. Known values include `3000` (transaction involves a sanctioned or unsupported wallet) and `2151` (transaction denied on outbound compliance screening; a failed refund, for example). Present when `decision` is `denied`; may be omitted for `review` decisions. type: string nullable: true example: '3000' UtcTimestamp: type: string description: ISO-8601 UTC date/time format. example: '2020-04-10T02:13:30.000Z' CryptoPayoutDestinationType: type: string description: The destination type. enum: - address_book responses: NotAuthorized: description: >- The request has not been applied because it lacks valid authentication credentials. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: type: object title: NotAuthorized required: - code - message properties: code: type: integer example: 400 message: type: string example: Something went wrong. example: code: 401 message: Malformed authorization. examples: response: value: code: 401 message: Malformed authorization. NotFound: description: The specified resource was not found. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: type: object title: NotFound required: - code - message properties: code: type: integer example: 400 message: type: string example: Something went wrong. example: code: 404 message: Not found. examples: response: value: code: 404 message: Not found. securitySchemes: bearerAuth: type: http scheme: bearer ````