Download the SDK

You can download the SDK by running:

npm install @breeze.cash/ui

yarn add @breeze.cash/ui

Embedding the payment page

Add the line to inject the stylesheet:

import "@breeze.cash/ui/styles.css";

You can get the pageId and clientSecret from creating a payment page endpoint.

import { BreezePaymentPage } from "@breeze.cash/ui";
import "@breeze.cash/ui/styles.css";

...
return (
  <BreezePaymentPage
    pageId="page_xxxxxxxxxxxx"
    clientSecret="pcs_xxxxxxxxxxx"
  />
);
...

Props

Name	Type	Description
pageId	`string`	The page ID that is returned from create payment page endpoint. This uniquely identifies the payment made.
clientSecret	`string`	This is returned from create payment page endpoint.
style	`CSSProperties`	CSS styles for the UI

Enabling Apple Pay for SDK

To enable Apple Pay for SDK usage, please email [email protected] for the merchant domain certification to allow Apple Pay be enabled when the SDK is hosted on your domain

Adding the domain certification

When you receive the domain certification from our support, you have to host it on your domain at the path {YOUR_DOMAIN}/.well-known/apple-developer-merchantid-domain-association.txt

If you are using Vite, you can simply add the textfile under /public folder.