Links

Channel hosted page

A channel hosted page is a web page that you can embed into your website to display the payment details of a particular channel to a customer.
There is a hosted_page_url attribute in the channel details that contains a URL to its hosted page.
API response example
{
"id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"name": "channel name",
"description": "channel description",
"receiver_currency": "EUR",
"pay_currency": "BTC",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"project_id": "25632c89-7f40-4693-8ed0-99bf5f79d3a6",
"custom_id": "631044494",
"uri": "bitcoin:2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967"
}

Settings

You can apply different settings to hosted pages appearance like a specific locale by adding its acronym to the end of the hosted_page_url value via a query parameter. For example:
Below is a list of variables you can use.
Parameter
Type
Description
locale
string
Can be en, de, fr, es, pt andjp which means English, German, French, Spanish, Portuguese or Japanese language. If parameter is not set, the language will be taken from the browser settings.
back_button
boolean
Show/hide a back button on the page. This might be useful if you redirect customers to hosted pages. false if set by default
isShowQr
boolean
Show/hide a QR code on the mobile version of the page. false if omitted
theme
string
Controls the color design of the hosted page. light (by default) or dark.