LogoLogo
  • Welcome to Subscribe
    • Introduction to Subscribe
    • Subscribe Release Notes
      • 2025.1
      • 3.17.0 Major Release
        • 3.17.0.x Hotfixes
        • 3.17.1 Minor Release
          • 3.17.1.x Hotfixes
        • 3.17.2 Minor Release
      • 3.16.0
        • 3.16.0.X Hotfixes
        • 3.16.1 Minor Release
          • 3.16.1.X Hotfixes
        • 3.16.2 Minor Release
          • 3.16.2.X Hotfixes
        • 3.16.3 Minor Release
          • 3.16.3.x Hotfixes
      • 3.15.0 and 3.15+
      • 3.14 and 3.14+
      • 3.13.0 and 3.13+
      • 3.12
      • 3.11
      • 3.10
      • 2.X Releases
    • Coming Soon: What's On Your Way
    • NCS Circ Service Packs
      • 2018.5 Service Pack 1
      • 2018.5 Service Pack 2
      • 2018.5 Service Pack 3
      • 2018.5 Service Pack 4
      • 2020.2.0 Version
      • 2020.2.1 Version
      • 2020.2.2 Version
      • 2020.3.0 Version
      • 2020.4.0 Version
        • 2020.4.0 Version - Resolved Issues
        • 2020.4.0 - Enhancements
  • Naviga Applications and User Guides
    • Landing Application User Guide
      • Create a New User
      • Editing User Details
      • Exporting the Users
      • Password Settings
    • Solicitor Concierge User Guide
      • Solicitor Quickstart
      • Find your way around the Solicitor UI
      • Tutorials
        • Audit Trail
        • Configure available areas
        • Configure a sales product
        • Configure marketing text
        • Configure terms and conditions
        • Configure premiums
        • Configure an offer group
        • Configure an activation fee
        • Configure users, sales teams, and team members
          • Best practices for user accounts
          • Roles and permissions matrix
        • Import or Export Solicitor Data
        • Reference tables
    • CSR User Guide
      • Account information
      • Subscription Search
      • New Subscription Registration
      • Sending Invites
      • Create a new subscription
      • Digital Product Management
      • Disclaimer Management
      • Registration Management
      • NCS Only
        • Delivery Issues and Delivery Management
        • Billing and payment management
        • Address management
        • Update Solicitation Preference
        • Upgrades and downgrades management
        • Temporarily stop a subscription
        • Permanently stop a subscription
        • Create a vacation transfer
        • Redirect to classic portal
        • Restart a Subscription
      • Matrix Only
        • Billing and payment management
      • Show events and access events
    • Subscription Panel User Guide
      • Overview
      • Tutorials, how-tos, and reference documentation
        • Component Matrix
        • Create, edit, or remove component properties
          • Common properties quickstart
        • Create, edit, or delete a Presentation Template
        • Create, edit, delete, import or export Presentations
        • Preview a Presentation
        • Tutorials and Step-by-step guides
        • Reference documentation
          • Analytics
          • Presentation URLs
    • CMS User Guide
      • Overview
      • Tutorials, how-tos
        • How to Create a New Page
        • How to Manage Attributes
        • How to Manage Benefits
        • How to Manage Rewards
        • How to Manage Content and Pages
        • How to Manage the FAQ Section
        • How to Manage Images
        • How to Manage Slideshows
        • How to Manage Navigation: Links, Menu, Footer
        • How to Manage Notifications
        • How to Manage Newspapers (Divisions) And Newspaper Groups
  • Subscribe Features
    • New Starts and Restarts
      • Active Subscription Check
      • New starts
        • Complimentary (free-of-charge) subscriptions
        • 'Day Pass' Subscriptions (NCS Circ)
        • Gift Subscriptions (NCS Circ)
        • Lite Subscriptions
        • Trial-with-Payment subscriptions (NCS Circ)
        • Country-Only-Start Subscriptions (NCS Circ)
        • Auth0 Email Verification
      • Occupant creation/update during a new start (NCS Circ)
      • PurchaseAPI and failed starts reprocessing
      • Restarts (NCS Circ)
      • Restarts (Matrix)
    • Payment features (NCS Circ)
      • Tip: One-time and Recurring (NCS Circ)
      • Activation fees (NCS Circ)
      • One-time payment and Auto-renew (NCS circ)
      • Apple Pay: NCS Circ, Payway & Braintree
      • Google Pay: NCS Circ, Payway / Braintree
      • Variable Pricing (NCS Circ)
    • Upgrades and Downgrades
    • Stop Saver (NCS Circ)
    • Multicurrency (Vindicia only)
      • Multicurrency set up user guide
    • Occupant data update
  • ADDITIONAL RESOURCES
    • Subscribe APIs
      • Newsletter Widget API
      • InApp API (External Payments)
      • Newstart InApp (Webhooks)
      • Subscription API
      • Entitlements API Reference
      • Firefly
    • Workflows
      • Make a Payment Workflow
      • Auto-renew Workflows
      • NCS Only
        • eBill Workflows
        • Vacation Transfer Workflow
        • Permanent Stop Workflow
        • Temporary Stop Workflow
        • Solicitation Preference Workflow
        • Delivery Issues Workflow
        • Address Management Workflow
        • Restarts
        • Subscription Purchase Workflows
      • Matrix Only
        • New Start (Matrix)
      • CircPro Only
        • New start Workflow
        • Complaints Workflow
        • Update Payment Information Workflow
        • Switch to Invoice Workflow
        • One Time Payment Workflow
        • Temporary Stop Workflow
      • New Start Flow
      • Move Flow
    • Videos & Webinars
Powered by GitBook
On this page
  • Goal
  • Before you start
  • Business Flow
  • Functional Details
  • CMS setup
  • Solicitor Concierge setup
  • Apple Pay Start in Classic CSR Portal
  • Technical Details
  • Apple Pay Certificates
  • Notes From the Payway Team

Was this helpful?

Export as PDF
  1. Subscribe Features
  2. Payment features (NCS Circ)

Apple Pay: NCS Circ, Payway & Braintree

PreviousOne-time payment and Auto-renew (NCS circ)NextGoogle Pay: NCS Circ, Payway / Braintree

Last updated 1 year ago

Was this helpful?

Goal

Apple Pay offers the possibility to have an electronic wallet under Apple platform during Subscribe checkout flow. The goal of this guide is to help you understand Apple Payments integration in Subscribe for the NCS Circ and Payway clients.

Before you start

Make sure you meet the following pre-requisites:

  • Minimum NCS Circ version required is 2020.2

  • Minimum Subscribe version required is 3.13.1

  • Subscribe must use PaywayWS to support Apple Pay. This service is a wrapper of EccoWS and PW_Web services

  • Every Payway request needs to go through PaywayWS

  • Client have to use Naviga Pay

  • For Braintree, the Minimum Subscribe version required is 3.15.1

Business Flow

Front end: Subscription Panel via Apple Pay JS and Payway

Back end: Subscribe APIs, NCS Circ, Naviga Pay

Functional Details

CMS setup

Subscription Panel interacts with an Apple Pay JS library. Subscription Panel offers the possibility to use ApplePay for Billing if a client is using Apple device. A user can select one of the two available options:

  1. Apple Pay option within the checkout pages - is supported in frictionless checkout starting from 3.15.0

You can find the CMS set up details and screenshots of the flow in the table below for each of these two options

From the CMS dashboard:

  1. Select subscription panel then presentations.

  2. Choose your desired presentation from the drop-down menu.

  3. Add the ApplePay V3 as a child component to the PaymentMethods V3 component.

  4. Select save and clear your app's cache by selecting the manage cache button, then the relevant app.

For this type of setup the end-user will have to fill delivery and billing address and user information

The way payment option is displayed can also be changed via CMS by using there is a property called PaymentMethodSelectorStyle property of PaymentMethods V3

Please see the example of the payment step at the screenshot below

From the CMS dashboard:

  1. Select subscription panel then presentations.

  2. Choose your desired presentation from the drop-down menu.

  3. Add the Offer Selector - ApplePay V3 as a child component to the checkout Page V3 component.

  4. Select save and clear your app's cache by selecting the manage cache button, then the relevant app.

Note:

  1. This option skips steps like filling up billing address and user information. By clicking on ‘Buy with Apple Pay’ data would come from Apple Pay;

  2. All the steps within check out flow including registration are skipped and user sees confirmation page. You can show an option to register on the confirmation screen;

  3. Data stored in Subscribe/NCS circ if we use Apple pay start as part of offer selector: it depends on user’s wallet settings in Apple. Some fields are optional. A fully set up apple pay account provides the same set of data as collected within subscription panel.

Offer selector screen

Screen after ‘Buy with Apple Pay’ click:

CMS Set up:

Solicitor Concierge setup

From the Solicitor Concierge dashboard:

  1. Select offer groups from the left sidebar. Your offer groups will appear in a list to the right.

  2. Select an offer group from the list, or create a new offer group.

  3. Select the additional options category, then select the payment method drop-down menu.

  4. Check the Apple Pay box. For Braintree, please select the Apple Pay - Braintree checkbox.

  5. Select update or save as new.

Apple Pay Start in Classic CSR Portal

When you're viewing a Subscription purchased with ApplePay in Classic CSR Portal you will be able to see a corresponding mark.

Technical Details

  • A huge Payload is sent to the Subscribe API, which is responsible of decrypting it. For doing so, an algorithm was included as part of the Encryption Library NuGet package.

  • To decrypt the value, the API provides the NuGet package with the MID and Private Key to be used. These are stored in MG2 Control just like any other setting.

  • The Encryption Library generates a Shared Secret with the Private Key (provided by API) and the Public Key (payload.Token.PaymentData.Header.EphemeralPublicKey from the Payload).

  • Then, the symmetric key gets generated by using the secret key and the MID. This is used to decrypt the payload.Token.PaymentData.Data (after a Base64 decode).

  • Once the data is decrypted, the API performs the regular Newstart flow: Authorization, Create Subscription, Capture Funds, Payment in Circ, Update Transaction. Refer to the sections Circ System and Payment Gateway for more information.

Apple Pay Certificates

Please input a Salesforce case requesting the Naviga team to setup ApplePay Certificates on your behalf.

Note updated on 04-Jul-23.

Notes From the Payway Team

  • You can use existing merchant ids on Payway. All GPAY and ApplePay leverage your existing merchant accounts at TSYS unlike PayPal or Amazon Pay;

  • All transactions are identified on Payway through the virtual terminal as a Credit Card, ACH, ApplePay, GPAY, etc. for all research inquiries (reports, etc). Note that we have engineered the virtual terminal to operate like credit cards on wallet transactions. That is, you can perform a SALE, CREDIT or VOID on GPAY or ApplePay accounts like you can do with credit cards from within the payway virtual terminal;

  • Disputes would be handled similarly but with one caveat for ApplePay transactions. The last four and expiry date that NCS receives and also assigned in payway for ApplePay transactions is not the customer’s actual credit card but rather the DPAN or device account number assigned to the customer’s card in the phone/IOS device. So, if there is a dispute, the CSR needs to ask the customer what the last four of the device account number is in their wallet on their device. That is just how applePay works.

  • From a recurring model, payway assigns our standard token to all transactions for recurring processing.

  • Management of CC update/expiry etc. in Apple: There is no communication with Apple. The token is valid in Payway if that device account number is valid. If a customer removes that card from their wallet, the token is invalid, and it would get declined.

Apple Pay option as part of offer selector - Please note that this option is not supported in

Please note that this option is not supported in .

More developer documentation can be found .

frictionless checkout
frictionless checkout
here
Apple Pay Business Flow
Payment step with ApplePay example
Payment method -> Apple Pay
Payment method -> Apple Pay - Braintree