White-label API Custom Domain Guide

api.paygate.to → your.domain

01 · Choose

02 · Use case

03 · Configure

04 · Deploy

[01] Choose your setup

Both keep your payments running when the shared PayGate API is under attack. Pick one now; you can add the other later.

RecommendedYour own custom domainapi.yourdomain.com → your Cloudflare worker → your dedicated PayGate endpoint. Your brand, optional affiliate earnings, the strongest DDoS isolation.

Your own dedicated API endpointFor WooCommerce, Easy Digital Downloads, WHMCS, FOSSBilling, Paymenter, OpenCart, PrestaShop, Magento or direct API use: a DDoS-protected address of your own instead of the shared api.paygate.to.

[04] Deploy

Your customized worker — wallet, domain and fees already filled in. Copy it into the Cloudflare worker editor, or download it. Then follow the steps below.

⚠

Never put your own domain in the targetUrl line — that is the PayGate address the proxy cloaks; your own domain is attached in Cloudflare (step 3 below). You only change the wallet, your domains, the error page and (if custom) the fee split. The targetUrl line changes only to your dedicated API endpoint, which this wizard sets for you in step 03.

[04b] Push it live

Create an empty Hello World worker, paste your generated code over it and connect your domain — four short steps.

Create an empty worker
Click below (sign in to Cloudflare if asked). Choose Start with Hello World!, name the worker (e.g. paygate-api) and press Deploy. It goes live on a free *.workers.dev URL (100,000 requests/day). In the dashboard this is Compute → Workers & Pages → Create application.

🚀 Create the worker on Cloudflare
Replace the Hello World code with YOUR code
On the new worker's page press Edit code (top right). Click into the code, select all (Ctrl/Cmd A), delete, and paste the customized worker.js from the box above (it has your wallet, domain & fees baked in). Then press Deploy in the editor.

⚠
The new worker only contains Cloudflare's Hello World sample — it doesn't know your wallet or domain. This paste step is what makes the worker actually yours, so don't skip it.
Connect your domain
In the worker, open the Domains tab and press Add Domain. Choose your domain and enter api.yourshop.com (your API address). Then press Add Domain again for (your payment page address). That's it: Cloudflare creates the DNS record and the SSL certificate for you, so there are no DNS records or routes to set up. Your domain must already be added to this Cloudflare account. If that subdomain already has a DNS record, delete it first.
Start using it
After a minute or two, api.yourshop.com works exactly like api.paygate.to. Use it wherever you used api.paygate.to: the API Domain (or Custom API Domain) setting of your PayGate plugin, or your own API calls. To test, call any endpoint from the API docs through your domain.

[02] Get your dedicated API endpoint

A DDoS-protected PayGate API address of your own. Use it instead of https://api.paygate.to in your plugin or code; nothing else changes.

Where to paste it

In WordPress, open WooCommerce → Settings → Payments. For each PayGate payment method you use, paste your endpoint into Custom API Domain and click Save changes.

In WordPress, open Downloads → Settings → Payments. In the PayGate.to Card and PayGate.to Crypto tabs, paste your endpoint into Dedicated API endpoint and click Save Changes.

Update to the latest PayGate module first. In WHMCS, open Configuration → System Settings → Payment Gateways. For each PayGate gateway, paste your endpoint into API Domain and click Save Changes.

In FOSSBilling, open System → Payment gateways. Click each PayGate gateway (PayGateCard, PayGateCrypto), paste your endpoint into Dedicated API endpoint and click Update Gateway.

In Paymenter, open Gateways. Edit each PayGate gateway (PayGateCard, PayGateCrypto), paste your endpoint into Dedicated API endpoint and click Save changes.

Update to PayGate module 1.1 or later first. Open Extensions → Extensions, choose Payments, edit PayGate, paste your endpoint into API Domain and click Save. For the crypto extension, do the same for PayGate.to Crypto (Individual Coins) and PayGate.to Crypto (Multicoin).

Update to PayGate module 1.1.0 or later first. Open Modules → Module Manager, find Instant Payment Gateway, click Configure, paste your endpoint into API Domain and click Save. For the crypto module, do the same in Crypto Payment Gateway (PayGate.to).

In Magento, open Stores → Configuration → Sales → Payment Methods. Under PayGate.to Card Payments, paste your endpoint into Custom API Domain and click Save Config. For the crypto module, paste it into API Domain under PayGate.to Crypto Payments.

Replace https://api.paygate.to with your endpoint in every request. Paths, parameters and responses stay exactly the same. Keep the address in one setting in your code so it is easy to change.

copied

In this tutorial you will learn how to use your own custom domain with our payment gateway API. You will be able to use your own domain instead of api.paygate.to and checkout.paygate.to. You will also be able to optionally insert your affiliate wallet to earn your desired percentage on every sale your sub-merchant receive.

You need to make 4 steps:

Your domain name must be using Cloudflare DNS service (free account plan will work fine).
Create a free Cloudflare worker with our JS code to use our API.
Connect your domain to the worker with one click (Add Domain). No DNS records or routes needed.
Optionally you can insert your affiliate wallet within the code and redistribute our plugins to earn percentage on your sub-merchant sales.

Use Cloudflare DNS

Create a free Cloudflare account
Add your domain name to use the free Cloudflare DNS service (Domains → Add domain → Connect a domain).
After adding your domain you will be instructed to change your domain’s nameservers (NS) records
Go to your domain registrar where you registered your domain and use the custom nameservers provided in your Cloudflare account. Those nameservers are different for each account.
After completing the previous steps your domain should be actively using Cloudflare. You don't need to add any DNS records for the API: Cloudflare creates them when you connect the domain to your worker below.

Create a Cloudflare Worker

In the Cloudflare dashboard sidebar open Compute → Workers & Pages.
Press the Create application button.
Choose Start with Hello World! This creates an empty worker you will replace with our code.
Name the worker (for example paygate-api) and press Deploy.
On the new worker's page press Edit code.
Select all the Hello World code in the editor, delete it and paste our worker.js code instead. We offer two versions: standard worker.js will allow you to use your own custom domain without an affiliate wallet injection this will simply allow you to use your custom domain with our API.
Optionally you can use the affiliate version worker.js which will allow you to use your hidden affiliate USDC (Polygon) wallet to earn 0.5% on every sale that go through your custom domain. Make sure to replace the wallet in the example code with your own USDC wallet to receive earnings.
⚠️ Don't change the API domain name in the code you need to change the wallet address and set a custom error page only.
Dedicated API endpoint
api.paygate.to in the worker is PayGate's address, not your own domain; your domain is connected in the worker's Domains tab. For the best protection, replace only the targetUrl host with your free dedicated API endpoint. The automatic generator above gets one for you and makes the change.
Press Deploy in the editor to publish the code.

The free Cloudflare plan will allow you to use 100,000 request per day with your own custom domain free of charge.

Connect Your Custom Domain to the Worker

Open the worker's Domains tab and press Add Domain.
Choose your domain and enter the subdomain you want to use instead of api.paygate.to, for example api.example.com. Cloudflare creates the DNS record and the SSL certificate automatically, so there are no DNS records or routes to set up. If that subdomain already has a DNS record, delete it first.
Press Add Domain again for your payment page address, for example payment.example.com instead of checkout.paygate.to. Your customers see this address on the hosted card and multi-coin crypto payment pages.
After a minute or two your domain works the same way as api.paygate.to. Use it wherever you used api.paygate.to, for example in the API Domain (or Custom API Domain) setting of your PayGate plugin.
You can follow the API Docs for testing.
Using the standard worker.js your domain will work exactly the same as the original API and in case you inserted the affiliate worker.js with your affiliate wallet hidden in the JS code; the parameter affiliate wallet will be added to each request.

Earning Affiliate Commission and White-label Plugins and Modules

All our plugins and modules are open-source and available to be modified or re-branded you can visit our GitHub to access all code.
You can easily re-brand all plugins or modules. You can replace all instances of api.paygate.to and checkout.paygate.to within the code with your own custom domain configured in the previous steps.
When you use the affiliate worker.js for your custom domain the affiliate parameter wallet will be added to every request without the need to insert it in the plugin code. This maybe useful to prevent your sub-merchant from removing your wallet or bypass your commission.
Feel free to contact our support for any questions.

Which worker.js File to Select

There are different ready made worker.js files you will probably need one of them only per your use case.

Default worker.js would allow you to use your custom domain for both the credit card and crypto systems without affiliate earning.
Default affiliate worker.js would allow you to use your custom domain for the credit card system with 0.5% affiliate earning to the wallet inserted in the worker code.
Custom affiliate worker.js would allow you to use your custom domain for the credit card system with custom affiliate earning percentage to the wallet inserted in the worker code.
Crypto affiliate worker.js would allow you to use your custom domain for both the credit card and crypto systems including crypto swapping with custom affiliate earning percentage to the wallets inserted in the worker code.
Increased affiliate worker.js commission optional easy usage credit card only affiliate workers with increased percentage set for your convenience.
Advanced full White-label would allow you to use your custom domain for all the credit card, crypto swap and crypto payment systems with custom affiliate earning percentage to the wallets inserted in the worker code. Also it will allow having your own credit card affiliate system for your white-label rebrand where your affiliates use workers to point to your custom API domain and set their own commission.

White-label API Custom Domain Guide

[01] Choose your setup

[02] What do you need?

[03] Your details

[04] Deploy

[04b] Push it live

[02] Get your dedicated API endpoint

Where to paste it

Use Cloudflare DNS

Create a Cloudflare Worker

Connect Your Custom Domain to the Worker

Earning Affiliate Commission and White-label Plugins and Modules

Which worker.js File to Select