Skip to main content
Clara’s VCN API enables companies to generate Virtual Card Numbers (VCNs) for controlled purchases, recurring subscriptions, and digital transactions. All charges made to a VCN are automatically debited from its associated Real Card Number (RCN).

​
Key Concepts

​
How VCNs Work

  1. Configure: An RCN and one or more templates are set up during the VCN onboarding process.
  2. Retrieve: Call GET /api/v1/vcn to get available RCNs, templates, and suppliers for your company.
  3. Create: Call POST /api/v1/vcn/submit with a template, RCN, and supplier to generate a VCN.
  4. Use: The VCN (PAN + CVV + expiry) is used for the purchase. Charges flow back to the RCN.
  5. Update or Cancel: Adjust limits with POST /api/v1/vcn/{purchaseId}/update or void with POST /api/v1/vcn/cancel.
  6. Reconcile: Generate and retrieve reports via POST/GET /api/v1/vcn/report.

​
Authentication and Security

The VCN API uses the same dual-layer authentication as all Clara APIs. Token Request:

​
Endpoint Overview

​
Sandbox

A sandbox environment is available for testing:
  • GET /api-test/v1/vcn/{path} — Sandbox read operations
  • POST /api-test/v1/vcn/{path} — Sandbox write operations
Contact your Clara integration support team for sandbox credentials.