Set up Apple Pay
This topic describes how to use FramePay to tokenize payments made using Apple Pay.
If you want to use Apple Pay inside an iOS application, contact us.
1. Obtain IDs and a publishable API key
- Obtain your organization ID and website ID:
- In the left navigation bar, click Settings .
- In the Management section, click My organization & websites.
- In the Organization details section, note the ID value.
- In the Website section, note the ID value. When you first log in to Rebilly, you create an organization as part of the setup process. A default website is created when a new organization is created. For more information, see Organizations and websites.
- Obtain your publishable API key:
- In the left navigation bar, click Automations .
- In the Development section, click API keys.
- Optionally, if you have not created a publishable key:
- In top right of the screen, click Add API.
- In the API key type section, select Publishable, then complete the form and click Save API key.
- Go back to the API Keys page.
- Select a publishable key and copy the Key value.
2. Set up Apple Pay
This step describes how to use FramePay to tokenize payments made using Apple Pay.
Initial set up
Set up the library and provide the HTML.
Include the FramePay stylesheet
This adds default styles to FramePay elements on the page.
Include the FramePay script
This exposes FramePay in the global JS scope as Framepay
.
Include the HTML mounting points
You must specify an empty HTML element where FramePay renders the Apple Pay button.
Edit your checkout form to add new HTML element with a unique ID.
Configure FramePay
This step describes the basic set up for mounting.
Initialize
Initialize FramePay with a configuration object.
Rebilly data
Provide your publishable API key, organization ID, and website ID to connect with the Rebilly API.
Transaction data
Provide the transaction data. Apple Pay requires amount, currency, and label.
Get the payment token
Mount FramePay onto your page and listen for a payment token.
Mount the Apple Pay button
After initialization, mount the Apple Pay button in the container element.
Listen for the generated payment token
When a customer completes the Apple Pay flow, Rebilly creates a payment token.
To retrieve it, listen for the token-ready
event.
Basic set up complete
To learn more about Apple Pay and FramePay, see: - Apple Pay domain registration - Apple Pay testing - Configuration reference
- HTML
- JavaScript
1<!doctype HTML>2<HTML>3 <head>4 <link href="https://framepay.rebilly.com/framepay.css" rel="stylesheet">5 <script src="https://framepay.rebilly.com/framepay.js"></script>6 </head>7 <body>8 <form>9 <div id="apple-pay-mount"></div>10 </form>11 </body>12</HTML>
1Framepay.initialize({2 publishableKey: 'pk_sandbox_123',3 organizationId: 'org-123',4 websiteId: 'website-123',5 transactionData: {6 currency: 'USD',7 amount: 10,8 label: 'Demo purchase label',9 lineItems: [10 {11 label: 'Subtotal',12 amount: '8.70',13 },14 {15 label: 'Tax',16 amount: '1.30',17 }18 ]19 },20});21Framepay.on('ready', function () {22 const applePay = Framepay.applePay.mount('#apple-pay-mount');23});24Framepay.on('token-ready', (data) => {25 // At this point, you can use the token for other operations26 // for example to create a payment instrument or transaction27 console.log('Payment token:', data);28});