CoinCircuit REST API, full endpoint reference.
/api/v1/blockchain/assets: Retrieve detailed supported blockchains and assetsReturns the full detailed list of supported blockchains and assets.
/api/v1/blockchain/confirmations: Retrieve confirmation requirementsReturns the number of confirmations required for transactions to be considered final on different blockchains.
/api/v1/blockchain/gas-fees: Retrieve gas feesReturns gas fees for all supported blockchains. All fee values are returned in the native token/asset value.
/api/v1/crypto-addresses: Create crypto addressCreate new crypto payout address.
/api/v1/crypto-addresses: List crypto addressesReturns all crypto addresses.
/api/v1/crypto-addresses/validate: Validate address formatValidates address format for a blockchain.
/api/v1/crypto-addresses/{id}: Retrieve crypto addressReturns the crypto address for the given ID.
/api/v1/crypto-addresses/{id}: Update crypto addressUpdates crypto address details.
/api/v1/crypto-addresses/{id}: Delete crypto addressDeletes the crypto address.
/api/v1/balance: Retrieve balanceReturns the balance for the specified currency, or default currency if not specified.
/api/v1/refunds/session/{sessionReference}: Process session refundRefunds the money received in a payment session back to the customer.
/api/v1/refunds/invoice/{invoiceReference}: Process invoice refundRefunds the money paid for an invoice back to the customer.
/api/v1/refunds: List refundsReturns all refunds.
/api/v1/refunds/estimate/{reference}: Estimate refund for a session or invoiceGet refund estimation including fees and amounts. Specify entity type (session/invoice) via query parameter.
/api/v1/refunds/{id}: Retrieve refundReturns the refund for the given ID.
/api/v1/payouts: Initiate payoutInitiates a payout to a receipient .
/api/v1/payouts: List payoutsReturns all payouts.
/api/v1/payouts/{id}: Retrieve payoutReturns the payout for the given ID.
/api/v1/payouts/fees: Retrieve all payout feesReturns both fiat and crypto payout fees for a specific currency in a clean, flat structure.
/api/v1/rates/convert: Retrieve conversion rateReturns the current conversion rate between any two supported currencies. Both "from" and "to" must be provided in uppercase.
/api/v1/rates: Retrieve all conversion ratesReturns all available conversion rates.
/api/v1/transactions: List transactionsReturns all Blockchain transactions.
/api/v1/transactions/{txHash}: Retrieve transactionReturns the transaction for the given hash.
/api/v1/payments: Create payment sessionCreates a new payment session (payment link) to receive payments. If asset, chain, and customer are all provided, a deposit address is generated immediately.
/api/v1/payments: List payment sessionsReturns all Payment Sessions.
/api/v1/payments/{reference}/address: Generate deposit addressGenerates a deposit address for the session using the specified asset and blockchain. If the session was created without customer details, the customer field is required (email, and optionally firstName, lastName, phone). If the session already has a customer attached, the customer field is ignored.
/api/v1/payments/reference/{reference}: Retrieve payment session by referenceReturns the session for the given reference.
/api/v1/payments/estimate: Calculate crypto amount for sessionCalculate the required crypto amount for a session based on selected asset and chain without locking the rate.
/api/v1/payments/agent/settle: Settle x402 paymentSettles a gasless x402 payment on-chain. The sender signs a payment authorization off-chain, and CoinCircuit submits the transaction and covers gas. Three schemes are supported: - **eip3009** (USDC on Base and Arbitrum): sender signs an EIP-3009 TransferWithAuthorization - **permit2** (USDC, USDT on Base, Arbitrum, BSC): sender signs a Uniswap Permit2 permit - **solana** (SOL, USDC, USDT on Solana): sender partially signs a Solana transaction, CoinCircuit co-signs as fee payer Supported on Base, Arbitrum, BSC, and Solana. Include a `sessionReference` to validate the payment against a checkout session.
/api/v1/payments/agent/verify: Verify x402 paymentDry-runs the x402 payment checks without settling on-chain. Validates scheme, chain, asset, session constraints (if sessionReference provided), and runs scheme-specific checks: - **eip3009**: timestamp validity, nonce replay, sender balance - **permit2**: deadline, sender balance - **solana**: transaction structure validation Returns 200 with `valid: true` on success, or 400 with per-check pass/fail breakdown.
/api/v1/customers: Create customerCreates a new customer. If a customer with the same email, phone, or telegram ID already exists, it will be updated instead.
/api/v1/customers: List customersReturns all customers.
/api/v1/customers/{id}: Update customerUpdates the customer.
/api/v1/customers/{id}: Retrieve customerReturns the customer for the given ID.
/api/v1/payments/pages: Create payment pageCreates a new payment page.
/api/v1/payments/pages: List payment pagesReturns all payment pages.
/api/v1/payments/pages/{reference}/sessions: Retrieve payment page by referenceReturns the payment page for the given reference.
/api/v1/payments/pages/{id}: Update payment pageUpdates the payment page.
/api/v1/payments/pages/{id}: Delete payment pageDeletes the payment page.
/api/v1/bank-accounts: Create bank accountCreates a new bank account for receiving fiat payouts. The account will be verified and must match your name or business name.
/api/v1/bank-accounts: List bank accountsReturns all bank accounts.
/api/v1/bank-accounts/{id}: Retrieve bank accountReturns the bank account for the given ID.
/api/v1/bank-accounts/{id}: Update bank accountUpdates bank account details.
/api/v1/bank-accounts/{id}: Delete bank accountDeletes the bank account. Cannot delete the only remaining account.
/api/v1/bank-accounts/banks: Retrieve bank listReturns the list of available banks.
/api/v1/invoices: Create invoiceCreates a new invoice. If no expiration date is provided, expires 12 hours after creation. Maximum expiration cannot exceed 2 days from creation. Invoices can be locked to a specific asset and chain or left open for customer selection, and support billing periods for recurring services.
/api/v1/invoices: List invoicesReturns all invoices.
/api/v1/invoices/reference/{reference}: Retrieve invoice by referenceReturns the invoice for the given reference.
/api/v1/settlements: List settlements/api/v1/settlements/{reference}: Retrieve settlement data