Paymentbox

The paymentbox (the hosted payment page) opens from a link or inside an iframe on your site. You can create it through the API (recommended: the amount does not travel in a URL the customer can edit) or build the URL yourself.

With the API

POST /v2/payments returns checkout_url, valid for 60 minutes. Redirect the customer or use it as the iframe src. See reference →

With a URL

https://paymentbox.e-payouts.com/?module=65cdef71-b6b8-11f1-8ee3-d721203bc734&price=25.00&currency=EUR&ucode=PEDIDO-1001&cname=Ana%20Garc%C3%ADa&cemail=ana%40example.com

v1 (compatible)

https://paymentbox.e-payouts.com/?uid=1001&mid=5001&price=25.00&ucode=PEDIDO-1001&cname=Ana%20Garc%C3%ADa&cemail=ana%40example.com

The v1 format (uid + mid) only works for migrated accounts with the v1 integration enabled; new accounts use modulo. v1 integration →

Parameter	Already in v1	Description
module required	new	Module id (UUID). In v1 format: uid (merchant) + mid (module).
price	yes, same name	Amount with a dot. If the module has a default price it is optional and replaces it; if the module price is marked as fixed, that one is charged and the URL amount is ignored.
currency	new	ISO 4217. Defaults to the merchant account currency (EUR or USD). If the customer pays in another one, it is converted to the account currency at the current rate. Not used in the v1 format.
ucode	yes, same name	Your order code (up to 64 characters: letters, digits and . _ : / # -). It comes back in the webhook and the redirect.
pm	yes, same name	Show only that method (if available).
cemail	yes, same name	Prefills the customer email.
cname	yes, same name	Prefills the customer name.
cc	yes, same name	Customer country (ISO alpha-2): affects pricing and methods, and the language if the browser does not state an available one.
localprice	yes, same name	v1 format only, together with cc: price in the country local currency (e.g. cc=uy&localprice=1000 = 1000 UYU). It is the same as requesting that amount and currency with module, price and currency: the checkout shows that amount and each method charges the equivalent it needs, at the current exchange rate. It takes precedence over price. In the v1 notice, price and currency are in your account currency. Countries: AR, BO, BR, CL, CO, CR, DO, GT, HN, MX, NI, PE, PY, UY.
lang	new	en \| es \| fr \| de \| it \| pt. Without it, the browser language is used; if it is not one of these, the country language; otherwise English. The customer can change it in the checkout.

If you do not send cc, the paymentbox detects the customer country from their IP and shows the methods for that country; the customer can change it in the page footer. With cc, that country is used and cannot be changed. If you create the payment through the API with method, name and email, the customer does not see the "Pay" screen: they go straight to the provider. For MB WAY (with phone, a Portuguese mobile) the screen is still shown, prefilled, and the customer confirms with one click, so nobody gets a payment notification on their phone they did not ask for.

With a URL, the customer could change the amount. Always confirm the payment through the webhook (verifying the signature) and compare amount and ucode with your order before delivering.

Iframe

HTML

<iframe src="https://paymentbox.e-payouts.com/?module=…&price=25.00&ucode=PEDIDO-1001" width="100%" height="640" style="border:0" title="e-Payouts"></iframe>

The paymentbox can only be embedded from the domain of the site registered in your merchant panel (Content-Security-Policy frame-ancestors). On wide screens it shows two columns; on mobile, one.

Back to your site

When done, the "Back" button goes to the module's success or error URL with these parameters (informational only: the valid confirmation is the webhook):

https://tu-sitio.com/gracias?code=9d6c9572-…&ucode=PEDIDO-1001&status=completed

code — e-Payouts payment id (in the v1 integration, the 12-character payment code).
ucode — your order code.
status — completed | pending | failed.
sandbox=1 — test payments only.