Branding

A branding puts your logo, name and colour on the checkout page instead of the Amboss look. Customers see your name in the header and your colour on the pay button, in both light and dark mode. A small "Powered by Amboss" note stays at the bottom.

• Brandings belong to your team, so sandbox and live share them.
• You can have up to 20, for example one per store or product.
• Each checkout picks one with style_id. A checkout without one keeps the Amboss look.

In the API a branding is called a checkout style (payment.checkout_style).

What a branding has

Every field except name is optional. Leave one out and the page uses the Amboss default for it.

In the dashboard

1. Go to Checkout in the sidebar and click Create branding.
2. Set a name, display name and colour. The preview shows the checkout page in light and dark.
3. Save, then upload a logo.
4. When you create a checkout link, pick the branding under Branding.

We check the real file type of a logo from its contents, so renaming a file doesn't change what we accept. We also scan each logo before storing it and refuse ones that show violence, sexual content or self-harm.

Deleting a branding also deletes its logo. Checkouts that used it go back to the Amboss look.

With the API

Reading brandings needs a service API key with ENVIRONMENTS: READ. See API Keys.

For now, you can only create, change or delete brandings and upload logos in the dashboard. Those calls need a key for the whole team, and every API key is limited to one environment.

List brandings

find_many lists all your brandings. find_one(id) gets one.

query ListBrandings {
  payment {
    checkout_style {
      find_many {
        id
        name
        display_name
        brand_color
        logo_url
      }
    }
  }
}

Use a branding on a checkout

Pass style_id in the checkout input of create_receive. It must be one of your team's brandings.

mutation CreateBrandedCheckout {
  payment {
    transaction {
      create_receive(input: {
        wallet_id: "5e4b1e2a-9f3c-4a5b-8c7d-1234567890ab"
        amount: "21000"
        checkout: {
          style_id: "3a5c7e9b-1d2f-4a6c-8e0b-2d4f6a8c0e1b"
          success_url: "https://shop.example.com/orders/42/thanks"
        }
      }) {
        id
        checkout { id url style_id }
      }
    }
  }
}

Next steps