# Invoice hosted page

An invoice hosted page is a web page that you can embed into your website to display the payment details of a particular invoice to a customer. 

There is a `hosted_page_url` attribute in the invoice details that contains its hosted page URL.<br>

<figure><img src="https://610376622-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LcumCsZ6ZxEPn6jqlMH%2Fuploads%2FJo0c79qyYhKokclQR7NT%2Fbyd.png?alt=media&#x26;token=b52fa619-ca48-4d0c-b0ce-83718267da36" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="API response example" %}

```javascript
{
  "id": "cc75b958-5780-4b34-a33a-cf63b349fbab",
  "custom_id": "209584732",
  "status": "new",
  "status_context": null,
  "address": "2NG8f2EVxN8XJ4DHriRt9q9LkdVCpQZ2UGB",
  "network": "bitcoin",
  "uri": "bitcoin:2NG8f2EVxN8XJ4DHriRt9q9LkdVCpQZ2UGB?amount=0.02038328",
  "price_amount": "100.0",
  "price_currency": "EUR",
  "pay_amount": "0.02038328",
  "pay_currency": "BTC",
  "fee": "1.0",
  "fee_currency": "EUR",
  "paid_amount": "0.0",
  "exchange": {
    "pair": "BTCEUR",
    "rate": "4905.9838",
    "fee": "0.0",
    "fee_currency": "EUR"
  },
  "transactions": [],
  "name": "invoice name",
  "description": "invoice description",
  "metadata": {
    "foo": "bar"
  },
  "success_redirect_url": null,
  "hosted_page_url": "https://business-hosted.cryptopay.me/invoices/cc75b958-5780-4b34-a33a-cf63b349fbab",
  "created_at": "2019-05-02T13:56:56+00:00",
  "expires_at": "2019-05-02T14:06:56+00:00"
}
```

{% endtab %}
{% endtabs %}

## 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:

[`https://business-hosted.cryptopay.me/invoices/b5cb2b8a-aa26-4b6b-b578-0fcc46c1f3a0` + `?locale=jp`](https://business-hosted.cryptopay.me/invoices/b5cb2b8a-aa26-4b6b-b578-0fcc46c1f3a0?locale=jp)

Below is a list of variables you can use.

| Parameter    | Type    | Description                                                                                                                                                                                                                                                                                                          |
| ------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| locale       | string  | <p>Can be <code>en</code>, <code>de</code>, <code>fr</code>, <code>es</code>, <code>pt</code>, <code>ru</code> and <code>jp</code> which means English, German, French, Spanish, Portuguese, Russian or Japanese language. </p><p>If parameter is not set, the language will be taken from the browser settings.</p> |
| 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                                                                                                                                                                                       |

## Transaction created

As soon as a sender broadcasts the transaction, you'll receive a callback with the following attributes:

`"event": "transaction_created"`

## Status changed

You'll receive one more callback when the invoice changes its status to one of the final ones (`completed` or `refunded`) upon transaction confirmation:

`"event": "status_changed"`

<figure><img src="https://610376622-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LcumCsZ6ZxEPn6jqlMH%2Fuploads%2FyiazjpoTMDHUQIrUdsOd%2FScreenshot%202026-01-29%20at%203.49.39%E2%80%AFPM.png?alt=media&#x26;token=1b1bd992-6ad5-477e-953e-ad643e66fc26" alt=""><figcaption></figcaption></figure>

## Invoice expired

<figure><img src="https://610376622-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LcumCsZ6ZxEPn6jqlMH%2Fuploads%2FApP2L7CQvu3OyF0soqmI%2FScreenshot%202026-01-29%20at%204.03.00%E2%80%AFPM.png?alt=media&#x26;token=64df13d4-0dfc-4ad3-ad5c-059e99e60b55" alt=""><figcaption></figcaption></figure>