Skip to main content
POST
Preview a pay-by-link message

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
url
string
required

The payment URL rendered into the message.

amountMinor
integer
required

Charge amount in minor units (same minimum as the mint endpoint).

currency
string
required

Three-letter ISO 4217 currency code.

description
string
required

What the payment is for.

preferredChannels
enum<string>[]
required

Delivery channels in descending priority order.

Available options:
sms,
rcs,
whatsapp,
email,
voice
reachableChannels
enum<string>[]
required

Channels the contact is currently reachable on.

Available options:
sms,
rcs,
whatsapp,
email,
voice
merchantName
string

Optional merchant name rendered into the message.

locale
string

Optional BCP-47 locale for the rendered message.

Response

Successful response.