> For the complete documentation index, see [llms.txt](https://docs.omypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omypayments.com/white-label/domains-and-proxy-setup.md).

# Domains and proxy setup

Your merchants, payers and customers only ever see your domain. You point a few subdomains of it at your own reverse proxy, and the proxy forwards the traffic to the OmyPayments servers. The platform recognises you by the `Host` of each request.

### Your domain

Use a **registrable second-level domain**, for example `partner.com`. Every subdomain of it belongs to you.

Domains under multi-label public suffixes, such as `partner.co.uk` or `partner.com.br`, are not supported.

### Subdomains

| Part               | Subdomain                                              | Notes                                                                                                                                                    |
| ------------------ | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Merchant dashboard | Any subdomain you choose, e.g. `dashboard.partner.com` | Where your merchants sign up and work. Its address is set in your branding as **Merchant dashboard URL**. Links in emails to merchants are built from it |
| Payment page       | Any subdomain you choose, e.g. `pay.partner.com`       | Its address is set in your branding as **Payment page URL**. Every invoice link is built from it                                                         |
| Customer dashboard | Any subdomain you choose, e.g. `customer.partner.com`  | Its address is set in your branding as **Customer dashboard URL**. Links in emails to customers are built from it                                        |

Both dashboards must be served over `https://`.

The Partner Dashboard is not on your domain: it is shared by all partners, and we send you its address.

Tell us the subdomains you choose before launch — see the [Onboarding checklist.](https://docs.omypayments.com/white-label/onboarding-checklist.md)

### Proxy requirements

Each subdomain is proxied **as a whole** to the upstream address we give you. The web application and its API live on the same subdomain: the application calls its API under the `/api` path on its own origin.

1. **Keep the original `Host` header.** The platform identifies you by it. With a rewritten `Host`, your merchants see the OmyPayments brand and sign-up on your domain fails.
2. **Proxy every path**, including `/api`, to the same upstream.
3. **Terminate TLS on your side.** Serve your subdomains over HTTPS with your own certificates.
4. **Do not cache** responses under `/api`.
5. **Do not strip or rewrite** cookies (`Cookie`, `Set-Cookie`) or the `X-CSRF-Token` header. Sessions and request protection depend on them.

### Example: nginx

One server block per subdomain. Replace the upstream with the address we provide.

```nginx
server {
    listen 443 ssl;
    server_name dashboard.partner.com;

    ssl_certificate     /etc/ssl/partner.com/fullchain.pem;
    ssl_certificate_key /etc/ssl/partner.com/privkey.pem;

    location / {
        proxy_pass https://UPSTREAM_PROVIDED_BY_OMYPAYMENTS;
        proxy_ssl_server_name on;

        # Required: the platform identifies you by the original host
        proxy_set_header Host $host;

        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_buffering off;
    }
}
```

Repeat the block for the payment page and customer dashboard subdomains.

### Checking the setup

Open each subdomain in a browser:

* the merchant dashboard sign-in page shows your logo, colours and name;
* the payment page favicon is yours;
* the customer dashboard sign-in page shows your brand.

If you see the OmyPayments brand instead, the `Host` header is not reaching us unchanged, or your images have not been uploaded yet.

### Wallets on the payment page

* **WalletConnect.** We register your payment page domain with WalletConnect for you — just tell us the domain.
* **TON Connect.** Nothing to do. The payment page serves the wallet manifest with your name and mark automatically.
