Introduction

The CIAO API connects two kinds of integrators:

Partners — businesses that get paid by customers via voucher redemption, either as a one-off payment (a Redemption Intent) or as a recurring top-up (a Subscription).

Resellers — businesses that sell CIAO vouchers to customers, either as a one-off sale or to fund a partner's subscription/redemption on the customer's behalf.

Customers never call the API directly. They complete payment in a browser, on a hosted CIAO checkout page you redirect them to (Partners) or, in some flows, indirectly through a reseller's own purchase flow (Resellers).

Read only the section that matches your API key. Partner and Reseller endpoints live under the same base URL but are not interchangeable — a Partner key gets 401 Unauthenticated on Reseller endpoints, and vice versa.

Base URL

https://app.ciao.cx/api/v1

There is no separate sandbox host. Test and live are the same base URL, distinguished entirely by which API key you send — see Authentication.

Before you write any code

Read these two pages first — every endpoint in this documentation assumes you already know them:

Authentication — how API keys, environments, and rate limiting work.

Responses & Errors — the response envelope, HTTP status codes, and the full error_code catalog.

Then jump to the quickstart for your role:

Quickstart — Partners

Quickstart — Resellers

Choose your path

You are a...	You...	Start here
Partner	Create redemption intents and subscriptions, redirect customers to a hosted checkout, get paid out, and receive webhooks when money moves.	Partners overview
Reseller	Sell vouchers — as one-off purchases, to fund a partner subscription cycle, or to settle a partner's redemption intent directly.	Resellers overview

Base URL#

Before you write any code#

Choose your path#

Base URL

Before you write any code

Choose your path