Clearway Documentation
  • Home
  • Guides
  • Merchant API
  • Investor Read API
API integration
Getting startedAuthenticationAPI keys and scopesRequest headersIdempotencyErrorsWebhook verificationWebhook eventsOrders and revenueSubscriptionsCheckout integrationDashboard vs APIRate limits
Investor / LP
Investor Read API
Merchant dashboard
Getting startedPayment links & chargesPayment widgetClearway ElementsCheckout & branding
powered by Zudoku
Guides

Idempotency

Idempotency

Money-moving operations accept an optional Idempotency-Key header. Reusing the same key with the same payload returns the original result instead of creating duplicate charges.

When to use it

PolicyMeaning
requiredHeader mandatory
recommendedStrongly advised for checkout and payment links
noneReads and listings

Generate a unique key per user intent (UUID recommended). Retries for the same intent should reuse the key.

Example

Send the request to {docsEnv.apiBaseUrl}:

Code
POST /CREATE_PAYMENT_LINK HTTP/1.1 Host: {docsEnv.apiHost} Authorization: Bearer {docsEnv.keyPrefixExample} Idempotency-Key: plink-intent-8f3c2a1b Content-Type: application/json { "amount": 2500, "currency": "USD", "productName": "Consultation" }

Use Sandbox or test keys in this environment.

Next steps

  • API Reference — idempotency policy per operation
  • Errors — failure codes
  • Getting started — first API call
Last modified on July 22, 2026
Request headersErrors
On this page
  • When to use it
  • Example
  • Next steps