Invoices and hosted checkout
A request for one payment with its own checkout page. The payer chooses an asset on a network, pays with a connected wallet or manually, and watches the confirmation. See Hosted checkout.
Crypto payments for your product
Create an invoice, send your customer to a hosted checkout page, and receive a signed webhook when the payment is confirmed.
How a payment works
Section titled “How a payment works”-
Your server creates an invoice. You say what is owed and which assets on which networks you accept, for example USDT on BNB Smart Chain. cTpeWay returns a
checkout_url. -
Your customer pays on the hosted checkout page. They connect a wallet or send the payment manually to the address and QR code shown. You build nothing for this step.
-
cTpeWay detects and confirms the payment. Your server receives a signed webhook,
invoice.paid, and you fulfil the order. -
The funds are released to your master wallet. cTpeWay charges a flat 0.5% platform fee on the deposit, in the network’s native coin. You receive
settlement.releasedwhen the funds have arrived.
Start here
Section titled “Start here”QuickstartYour first test payment in a few minutes, with the Node SDK or cURL.
InvoicesWhat an invoice is, the statuses it moves through and what to do in each.
Settlement and the platform feePending, Held and Released, and how the 0.5% fee is charged.
WebhooksEvents, verifying signatures, retries and replaying a delivery.
TestingTest networks, faucets and simulated payments that need no funds.
Node SDK and command-line toolInstall @ctpeway/sdk, call the API and verify webhooks.
What you can build with
Section titled “What you can build with”Reusable deposit addresses
A named address that can be paid any number of times, for example one per customer. See Reusable deposit addresses.
Test mode
A separate place with its own keys and data, on public test networks, with a payment simulator. See Test mode and live mode.
Signed webhooks
Every state change is an event, signed with your endpoint’s secret, retried if your server is down, and kept in a log you can replay. See Webhooks.
What is published today
Section titled “What is published today”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.
If you already use the v1 API (/api/wallet/create, /api/withdraw), read Moving from the v1 API: v1 stops at the cutover, and your integration has to move to v2.