Ramp Widget

Create Ramp Widget Session

Generate a session token and widget URL for the ZBD Ramp widget.

post/v1/ramp-widget

Request

The document declares no server URL.
Auth
API key in header apikey
TypeScript
https://skmtc.dev/zbdpay/apis/zbd-payments-api/docs/v1/ramp-widget/post.ts
A function with typed inputs. Its response is checked against the schema.

Content-Typestring

Content Type

emailstring

Email address of the user launching the Ramp

webhook_urlstring

URL to receive webhook notifications

quote_currencystring

Currency to convert from (e.g., USD)

base_currencystring

Currency to convert to (e.g., BTC)

destinationstring

Destination address for the funds (Lightning Address, onchain address, or USDC address)

reference_idstring

Your internal reference ID for this transaction

metadataobject

Additional metadata for the transaction

Successful response