SDKs & libraries

Note

SDKs are in active development. The REST API is stable and fully documented — you can integrate directly today.

SDK status

Language	Package	Status
Java / Kotlin	com.vauchflow:vauchflow-java	In development
JavaScript / TypeScript	@vauchflow/sdk	In development
Python	vauchflow-python	Planned
PHP	vauchflow/vauchflow-php	Planned

Java / Kotlin (preview)

<!-- Maven -->
<dependency>
  <groupId>com.vauchflow</groupId>
  <artifactId>vauchflow-java</artifactId>
  <version>0.1.0</version>
</dependency>

val client = VauchflowClient("vf_sk_YOUR_KEY")

val voucher = client.vouchers.redeem("SAVE20") {
  customerId = "cust_123"
  orderValue = BigDecimal("89.99")
}

println(voucher.discountApplied) // 17.998

JavaScript / TypeScript (preview)

npm install @vauchflow/sdk

import { VauchflowClient } from '@vauchflow/sdk';

const client = new VauchflowClient('vf_sk_YOUR_KEY');

const result = await client.vouchers.redeem('SAVE20', {
  customerId: 'cust_123',
  orderValue: 89.99,
});

console.log(result.discountApplied); // 17.998

Using the REST API directly

While the SDKs are being finalised, the REST API is production-ready. See the API Reference for all endpoints and the Getting Started guide for a working curl quickstart.

All SDK clients will follow the same authentication and idempotency semantics as the REST API.