Clearway Documentation
stringstringboolean · required
string · requiredstringstringboolean · required
stringstringboolean · required
Payments
Preview platform fees
POST
https://api-dev.clearway.to
/PREVIEW_PLATFORM_FEE
Simulate Clearway platform fees and wallet impact for a hypothetical charge amount without creating payment objects.
Headers
x-cidOptional correlation id for support trails.
x-brand-idOptional platform brand slug for multi-brand merchants.
Preview platform fees › Responses
Success
successProcess refunds
POST
https://api-dev.clearway.to
/PROCESS_MERCHANT_REFUND
Issue full or partial refunds on paid destination charges (reverse_transfer). Requires a client idempotency token per attempt.
Headers
Idempotency-KeyStable key for safe retries on money-moving requests.
x-cidOptional correlation id for support trails.
x-brand-idOptional platform brand slug for multi-brand merchants.
Process refunds › Responses
Success
successResolve embed display
POST
https://api-dev.clearway.to
/RESOLVE_EMBED_DISPLAY
Resolve tamper-safe catalog display payloads for Clearway Elements product cards and subscription modals.
Headers
x-cidOptional correlation id for support trails.
x-brand-idOptional platform brand slug for multi-brand merchants.
Resolve embed display › Responses
Success
success