Skip to content
Docsv2 preview

Changelog

Changes to the cTpeWay API, the Node SDK and this documentation, newest first.

cTpeWay v2 is in preview and has not been released. Until it is, entries here record what has been added to the preview.

13 October 2026

Section titled “13 October 2026”

Documentation

Section titled “Documentation”
  • First preview of the cTpeWay v2 developer documentation: quickstart, concepts, guides, SDK and command-line reference, and an API reference generated from the API description.

API description

Section titled “API description”
  • The merchant API description now covers invoices, reusable deposit addresses, payments, settlements, master wallets, networks, assets, rates, payouts, refunds, webhook endpoints, the event log and the test-mode simulators.
  • Every endpoint lists the error codes it can answer with, and Errors lists all of them.
  • Added: accepting an underpaid or late invoice in one call, customer_email on invoices, quotes rounded up to a display precision (display_decimals), confirming a simulated payment, the payment.transaction_attached event, and comma-separated statuses and more filters on lists.
  • A new secret key has no payout or refund permission unless it is granted, and a key that has it must be limited by an IP allowlist (it then pays any valid address, from those IP addresses only), by a payout allowlist, or by both.
  • Added: invoice.refunded and invoice.partially_refunded, the list of settlement reason values, confirmation_rule, confirmations_required and estimated_confirmation_seconds on networks, and test-mode endpoints to add confirmations one by one and to simulate a payment whose transaction is found later.
  • Changed: a payment found by a balance change has no tx_hash until payment.transaction_attached. Publishable keys can call only list networks, list assets and get rate. A stored idempotent answer belongs to the key that made the request.
  • The reference pages on this site are generated from the API description and follow each change.

The API description currently defines 46 endpoints and32 webhook events. They are listed in theAPI reference and under Webhook events. Anything else these docs mention is part of the v2 design and is markedplanned until the API description includes it.

Moving from v1

Section titled “Moving from v1”
  • v1 stops at the cutover: the v1 API, v1 keys and v1 callbacks all end then. Moving from the v1 API says what carries over by itself and what an integration must change.

SDK

Section titled “SDK”
  • @ctpeway/sdk 0.1.0 is ready as a preview, with the ctpeway command-line tool. It is not published to npm yet. See Node SDK.