Skip to content
BLINKYPAYdocs
IntegrationManual
PTEN
Go to dashboard

Checkout

A checkout template defines the page where the buyer pays: the look, what they fill in and how they pay. In the menu, open Charge → Checkout. The screen is called Checkout templates.

Templates are used by Payment links and by the API: the template identifier goes in the API checkout field.

#The list

Your templates shows the templates you created. Each card has the name, the template identifier (with a copy button), the language and the Default, Active or Inactive badges. The buttons are:

  • Edit: opens the full editor.
  • Clone: creates a copy and opens it in the editor.
  • Deactivate or Activate: the API stops using a deactivated template on new charges. Payment links that already use the template stay live.
  • Default: makes the template the default.
  • Delete: asks for confirmation and cannot be undone. A template used by any payment link cannot be deleted; the screen says how many links use it and offers See payment links.

Ready-made BlinkyPay templates shows the templates that come with the account, with the Ready-made template badge. They cannot be edited: use Clone to create your own version.

#Create a template

Click Create template. The New checkout template assistant has four steps and shows, on the side, a preview that changes as you choose. Nothing is saved until the review.

#1. Identity

  • Template name: only you see it. The buyer sees the store name.
  • Logo (image URL): PNG or SVG, starting with https://. Without a logo, the checkout shows the store initials.
  • Main color: when your brand has a color set, Use the brand color goes back to it.
  • Checkout background: Light or Dark.
  • Advanced: checkout address, favicon, font: the Checkout address is generated from the name and is what the API uses in the checkout field (lowercase letters, numbers and hyphens only, not repeating another template's). Favicon and Font are there too.

Logo and color come from your brand in Settings, when set (see Settings).

#2. Buyer

Check what the buyer fills in: Name, E-mail, Tax ID, Phone and Address. Name, e-mail and tax ID come checked. The tax ID is marked as recommended because it helps your defense in a MED. The address adds several fields. At least one field must stay checked.

#3. Payment

The list shows the methods possible for the currency of your registration. Check the ones the checkout offers and pick one as Recommended, which comes preselected for the buyer. At least one method must stay checked. The checkout only shows the methods available to your account at charge time.

Also pick the Default language: Português (Brasil), English, Español or Português (Portugal). The Currency is the one from your registration. Other languages, other currencies and the FX notice live in Advanced settings, after creating.

#4. Review

The review shows the preview and a summary of what will be created. Check Use as default for new charges and payment links if you want this one to be the default.

The account's first template starts active. The next ones start off, unless they become the default.

Click Create template. The screen confirms it, shows the Checkout address and the template's state, and offers Advanced settings, which opens the full editor.

#Edit a template

Edit opens Edit template, with the preview on the side. At the top are Template name, the template identifier and Active template. The rest is split into tabs:

TabWhat it changes
Visuallogo, favicon, colors, font, background, border radius, showing "Powered by BlinkyPay" and a Custom CSS (use with care)
Textsthe checkout texts in each language (empty uses the default text) and the support, terms, privacy and success redirect links
Layoutturns the page sections on and off, reorders and renames them
Fieldswhat the buyer fills in, including the address
Methodswhich methods show up, in what order and which one is recommended
Languages & Currenciesdefault language, other languages, other currencies and the FX notice

Click Save template to save. Cancel closes without saving.

Questions this page does not answer? Write to suporte@pay.blinkyapi.com.