Skip to main content
Integration-facing changes to the CoinVoyage SDK, API, and platform behavior are documented here. Internal implementation details are omitted unless they change what you configure, call, receive, or need to handle in production. Releases follow Semantic Versioning: major versions for breaking changes, minor for new backward-compatible functionality, and patch for bug fixes.
Current docs describe the v3 API and PayKit ^3 surface. If you are upgrading from v2, start with the v2 to v3 migration guide. Older entries below are retained for historical context.

​
3.4.0 - 2026-08-03

Added
  • Invoice generation via API: Create and publish invoices, save drafts, list and retrieve invoices, archive invoices, and delete unpublished drafts through the v3 API and ApiClient. Published invoices create a linked SALE order and email the recipient a PDF with a hosted payment link. See the Invoices guide.
Changed
  • Recoverable Pay to Address partial payments: Orders in PARTIAL_PAYMENT can now accept additional deposits through Pay to Address until the required amount is received and the order can be fulfilled. This recovery behavior is available only for Pay to Address; other payment methods still require a separate resolution flow.

​
3.3.0 - 2026-07-29

This release changes the portfolio() request and response shapes. Replace the singular wallet field with a wallets array and handle per-wallet results and errors. See the ApiClient migration example.
Added
  • Robinhood Chain: Added payment and settlement support for Robinhood Chain (4663).
  • Across provider: Added Across as a cross-chain routing provider.
  • Uniswap V2 and V4: Expanded Uniswap routing beyond V3 to include V2 and V4 liquidity.
  • EUR card payments: Card Payments can now fund eligible orders in EUR as well as USD.
Changed
  • Multi-wallet portfolio requests: ApiClient.portfolio() and POST /wallet/portfolio now accept wallets, an array of 1–10 wallets. Responses contain a portfolio array of successful scans and an errors array for wallets that could not be scanned.
Removed
  • ChangeNow provider: ChangeNow is no longer used for routing.

​
3.2.0 - 2026-07-07

Added
  • PayButton direct payment routing: PayButton and PayButton.Custom now accept paymentMethod, so integrations can open the modal directly to PaymentMethod.WALLET, PaymentMethod.DEPOSIT_ADDRESS, or PaymentMethod.CARD instead of first showing method selection.
Changed
  • On-ramp API errors: On-ramp API responses now return user-friendly error.message values for common Link, identity, payment-method, session, and checkout failures.

​
3.1.0 - 2026-06-27

Changed
  • PayKit Modal: Improvements to Card Payment flow

​
3.0.0 - 2026-06-25

Changed
  • API base URL: Current API requests use https://api.coinvoyage.io/v3; the generated OpenAPI reference is served from /v3/openapi.json.
  • Order API naming: SDK helpers now use Order naming: createDepositOrder(), createSaleOrder(), createRefundOrder(), getOrder(), listOrders(), orderQuotes(), createPayment(), and getOrderPaymentMethods().
  • PayButton lifecycle callbacks: Payment lifecycle callbacks are now split into onAwaitingPayment, onConfirmingPayment, onExecutingPayment, onPaymentCompleted, and onPaymentBounced.
  • Off-ramp API naming: Verification and fiat payout APIs use createOffRampVerification(), getOffRampVerificationStatus(), listOffRampIntents(), and createOffRampIntent().
  • Webhook payloads: Webhook deliveries now use the v3 envelope { event, delivered_at, order } with uppercase ORDER_* event identifiers.
See the v2 to v3 migration guide for before-and-after examples. Removed
  • Legacy PayOrder client helper names: createDepositPayOrder(), createSalePayOrder(), createRefundPayOrder(), getPayOrder(), listPayOrders(), payOrderQuote(), payOrderPaymentDetails(), getPayOrderPaymentMethods(), and swapData() are no longer the current PayKit API surface.

​
2.5.0 - 2026-05-27

Added
  • KYC helpers: ApiClient.createKYCLink() creates an identity-verification link for an organization, and ApiClient.getKYCStatus() retrieves the current KYC and terms-of-service status.
Changed
  • Signed organization methods: ApiClient.listPayOrders(), ApiClient.listWithdrawals(), and ApiClient.createWithdrawal() now require apiSecret as an argument. Server integrations that call these methods must pass the API secret from server-side code.

​
2.4.6 - 2026-05-27

Added
  • PayKit Headless (Preview): Added @coin-voyage/paykit-headless for server and agent runtimes that need to satisfy CoinVoyage x402 PAYMENT-REQUIRED challenges. Sui x402 signing is supported through this package.
  • Order status WebSocket hook: Added useOrderStatusWS() for React integrations that need live backend PayOrder events outside the default PayButton UI.
  • Backend API access: Added useBackendApi() for advanced PayKit integrations that need direct access to the configured API client.
  • ApiClient helpers: Added currencySearch(), portfolio(), listPayOrders(), listBankAccounts(), getBankAccount(), addBankAccount(), listWithdrawals(), and createWithdrawal().
  • Organization-wide WebSocket subscriptions: ApiClient.subscribeOrderStatus() can now subscribe to all organization PayOrder events when called with a server-generated authorization signature for GET /ws.
Changed
  • Quote filters: PayOrderQuoteParams now accepts chain_ids instead of a single chain_id.
  • Swap requests: Swap requests now support payment_rail and nested crypto input options, including source_currency, sender_address, and slippage_bps.
  • Route quote field: Route quote responses use quote_id.
  • Payment details: Payment details now use the shared PaymentDataBase shape for rail-specific payment instruction data.
Fixed
  • PayButton order creation errors: Backend order-creation failures are now surfaced to consumers.
  • PayButton lifecycle callbacks: Payment lifecycle callbacks continue working across multiple orders for the same button.
  • resetOnSuccess behavior: Successful payments reset payment state when configured.
  • EVM transaction errors: User-facing EVM transaction errors are clearer.
  • Desktop WalletConnect: Desktop WalletConnect routes through the QR flow correctly.

​
2.4.1 — 2026-04-08

Added
  • PARTIAL_PAYMENT status: A new terminal state for PayOrders that receive an insufficient amount. Use this status to detect and handle partial-payment outcomes in your order fulfillment logic.
  • PayOrderPartialPaymentEvent: A new event type so you can explicitly handle partial-payment outcomes in your event flows.

​
2.4.0 — 2026-04-04

Added
  • Stripe on-ramp integration: Full Stripe fiat-to-crypto on-ramp support, including geo-blocking for restricted regions.
  • PaymentSteps model: Tracks granular payment progress across stages such as on-ramp, swap, and delivery.
  • Payment methods endpoint: GET /pay-orders/{payorder_id}/payment-methods returns available payment methods for a given PayOrder.
  • Organization settings in PayOrder responses: Organization.settings is now a JSON field and is returned in GET /pay-orders and GET /pay-orders/{payorder_id} responses.
  • hosted_url field: Added to GET /pay-orders and GET /pay-orders/{payorder_id} responses so you can link customers directly to the hosted pay page.
Changed
  • Webhook payload coverage: payorder_error and payorder_refunded events now include the full payment_data object.
  • PayKit payment handling: The widget now consumes payment_data.steps, supports organization settings, and exposes location-aware payment method options.
  • SDK request and response models: Added metadata support to ClaimFeesRequest and SwapQuoteRequest, updated order event types and ClaimFeeResponse, and expanded ApiClient to accept Opts.
  • EVM prefunding flow: Improved prefunding across CCTP, Direct, Relay, and Uniswap providers with better gas estimation, prefund calculation, and error handling.
Fixed
  • Webhook subscription filtering: Webhook deliveries now correctly respect each subscriber’s registered event types.
  • Payment state persistence: Improved handling of payment_data so the correct exchange state is always persisted throughout the payment flow.
  • Refund PayOrder client flow: Fixed createRefundPayOrder handling in ApiClient.
  • WalletConnect desktop routing: Desktop WalletConnect flows now route through the QR flow correctly.
Removed
  • Deprecated RequestData / request field: Removed from PayOrderResponse.
  • Legacy transaction hash aliases: Removed SourceTransactionHash and DestinationTransactionHash alias fields.

​
2.0.0 — 2026-01-28

This release contains breaking changes. See the Migration Guide before upgrading.
Added
  • List Pay Orders endpoint: GET /pay-orders retrieves all pay orders for your organization with pagination and status filtering.
  • Quote breakdown transparency: Quotes now expose detailed fee breakdowns including base, fees, gas, and total.
  • Multi-provider execution tracking: payment.execution tracks execution status across multiple providers.
  • ApiClient constructor options: Added sessionId and version options.
  • Dedicated PayOrder helpers: createDepositPayOrder() and createSalePayOrder() provide clearer intent for each payment flow.
Changed
  • API base URL: Updated to https://api.coinvoyage.io/v2/.
  • Response structure: Flat fields moved into nested payment and fulfillment objects.
  • BigInt handling: raw_amount fields now return strings instead of numbers to prevent precision loss.
  • Authorization signature: generateAuthorizationSignature() now uses HMAC-SHA256 and requires method and path.
  • Sale and refund authorization: createSalePayOrder() and createRefundPayOrder() now accept apiSecret directly instead of a pre-generated signature.
  • Webhook event naming: Webhook subscriptions use uppercase ORDER_* identifiers; delivered payloads use lowercase payorder_* values in the type field.
Removed
  • Process endpoint: /pay-orders/{payorder_id}/process has been removed. Payment processing now happens automatically when funds are detected.
Deprecated
  • Top-level response fields: source_currency, source_amount, destination_currency, destination_amount, deposit_address, receiving_address, refund_address, and expires_at are deprecated at the top level. Use the corresponding nested fields in payment and fulfillment instead.

​
0.1.25 — 2025-11-04

Added
  • Phantom wallet (EVM): Users can now connect an EVM wallet through the Phantom browser extension.

​
0.1.24 — 2025-10-29

Added
  • German localization: Display the PayKit modal in German by specifying the de-DE language in your widget configuration.
Changed
  • ApiClient responses: All ApiClient methods now return APIResponse<T> for a consistent response shape.

​
0.1.23 — 2025-10-21

Changed
  • WalletProvider props: Updated property names and nesting structure. Review your WalletProvider configuration if you pass custom props.

​
0.1.22 — 2025-10-17

Added
  • Stable Testnet support: Added support for the Stable Testnet network so you can test integrations without using mainnet funds.