Skip to main content
POST
Create a ramp widget session for checkout

Integration guide

Authorizations

x-app-id
string
header
required

Your application ID. Required on app-tier and user-tier routes. Omitted on routes that authenticate with x-app-api-key only.

Body

application/json
sourceAmount
string
required

Amount to pay, in sourceCurrencyCode units, as a decimal string (e.g. "50").

sourceCurrencyCode
string
required
destinationCurrencyCode
string
required
serviceProvider
string
required
walletAddress
string
required
redirectUrl
string

Response

200

id
string
required

Session id.

token
string
required

Session token for the checkout widget.

widgetUrl
string
required

URL of the checkout widget to open.

serviceProviderWidgetUrl
string
required

The provider's own checkout URL.