CIC Pay for developers
These pages are for the developer who connects a merchant’s systems to CIC Pay. Your server creates the payment. The payer completes it on a page we host. Your server then reads the result. We choose the route the payment takes in between. Card numbers stay with us from start to end and never reach your systems.
From request to result
- From your server, create a session. The response includes a
checkoutUrl. - Redirect the payer to that URL as returned. Payment happens there.
- Read the outcome on your server. A signed webhook carries it, and so does the payment record when you fetch it.
Run a test payment takes each step once, on test data. API conventions gives the base URL and the conventions every endpoint shares, plus the OpenAPI document for generating a client. Each change to the API, with its date, is listed in Changes and versioning.
The six shelves
Basics
- Run a test paymentTake one payment through every step on test data
- Keys and accessGet keys, store them safely, keep test data and live apart, check scopes
- API conventionsBase URL, amounts, retries, pagination, the OpenAPI document and an index of every route
- Error codesAct on each error code, and know when to retry
- Get live accessPass the review and start taking real money
- Changes and versioningWhat changed, with its date, and what can change without notice
Take payments
- Start a checkoutCreate a session from your server: stores, order references, idempotency, return URLs
- Payer and order detailsSend the payer, the billing address and the order lines that card approval depends on
- On the payment pageThe checkout link, the way back, direct redirect, scan-to-pay and partner pages
- Payment linksLet us send the link by email and WhatsApp, from your own domain
- Confirm the outcomeConfirm a payment server-side and read every status and field
- Read a declineLearn why an attempt failed, and who can resolve it
- Report sales to ad platformsSend checkout and purchase events from our servers to TikTok, Google Ads or Meta
After the sale
- Refunding a payerReturn money to a payer from the dashboard or your code
- Disputes and fraud alertsFollow a contested payment and the warnings that come before one
- Report shipmentsSend the carrier and tracking number of a captured payment before its deadline
Payouts
- Your balanceWhat is available, held in reserve or still on its way
- Settlements and statementsEvery payout and the line items behind it
- Reconcile and exportSearch payments, read their history and export them as CSV
Webhooks and events
- Set up an endpointBe told when a payment changes state: create an endpoint and choose its events
- Verify and acknowledgeCheck every signature, answer fast and handle repeats
- Deliveries and testsThe delivery log, redelivery, samples and test deliveries
- Event catalogueEvery event type and the fields some of them carry
- The event logRead every event raised on your account, delivered or not
Your storefront
- Install the pluginInstall CIC Pay for WooCommerce, connect it and keep it current
- Shape the checkoutChoose the methods, their order and wording, and card fields in your checkout
- Orders in WooCommerceWhat the plugin writes on orders, refunds, order sync, attribution and fixes
- Headless storefrontsRun the checkout from your own storefront application
- Installation APIRegister a storefront, read and write its checkout setup
- Order push APICopy a storefront's orders into CIC Pay