You can accept Apple Pay on a payment page by enabling the payment method. You can also customize the Apple Pay button style, color, and language as needed.

Considerations

Before you get started, keep these considerations in mind:

  • You must have the Apple Pay service activated and payment method domains configured for your paypoint. See Apple Pay Overview for guidance.
  • Apple Pay is available only for one-time payments. If autopay is enabled on a payment page, Apple Pay won’t be available as a payment method.
  • For performance reasons, we don’t recommend embedding payment pages in iframes. However, when Apple Pay is enabled, a payment page embedded in an iframe won’t load at all.

Add Apple Pay to the payment page

To add Apple Pay acceptance on a payment page, you must first enable it as a payment method. Set applePay to true when creating or updating the payment page.


  "pageContent": {
    "paymentMethods": {
      "methods": {
        "applePay": true,
        "amex": true,
        "discover": true,
        "mastercard": true,
        "visa": true
      }
    }
  }

Configure the Apple Pay button

If you wish to customize the Apple Pay button on the payment page, you can pass configuration options using the paymentMethods.settings.applepay object.

buttonStyle
enum
default:
"black"

The Apple Pay button style. Supported options:

  • “black”: Default black button.
  • “white-outline”: White button with an outline.
  • “white”: Solid white button.
buttonType
enum
default:
"pay"

The text on Apple Pay button. Supported options:

Button TypeDescriptionText on Apple Pay Button
"plain"An Apple Pay button with the Apple Pay logo only, useful when an additional call to action isn’t needed.Apple Pay logo only (no text)
"buy"Use this button for product purchases.Buy with Apple Pay logo
"donate"Used by approved nonprofits. Lets people make donations.Donate with Apple Pay logo
"check-out"Use this button for purchase experiences that include other payment buttons that start with “Check out”.Check Out with Apple Pay logo
"book"Use this button for booking appointments, flights, or other experiences.Book with Apple Pay logo
"continue"Use this button for general purchases.Continue with Apple Pay logo
"top-up"Use this button for adding money to an account, or payment system.Top Up with Apple Pay logo
"order"Use this button for placing orders for items.Order with Apple Pay logo
"rent"Use this button for renting items such as equipment or cars.Rent with Apple Pay logo
"support"Use this button for helping people give money to projects, causes, organizations, and other entities.Support with Apple Pay logo
"contribute"Use this button to help people give money to projects, causes, organizations, and other entities.Contribute with Apple Pay logo
"tip"Use this button to let people tip for goods or services.Tip with Apple Pay logo
"pay"Use this button for general purchases.Pay with Apple Pay logo
language
enum
default:
"en-us"

The Apple Pay button locale. Supported options:

  • en-US: English (US)
  • ar-AB: Arabic
  • ca-ES: Catalan
  • zh-CN: Chinese (China)
  • zh-HK: Chinese (Hong Kong)
  • zh-TW: Chinese (Taiwan)
  • hr-HR: Croatian
  • cs-CZ: Czech
  • da-DK: Danish
  • de-DE: German
  • nl-NL: Dutch
  • en-AU: English (Australia)
  • en-GB: English (UK)
  • fi-FI: Finnish
  • fr-CA: French (Canada)
  • fr-FR: French (France)
  • el-GR: Greek
  • he-IL: Hebrew
  • hi-IN: Hindi
  • hu-HU: Hungarian
  • id-ID: Indonesian
  • it-IT: Italian
  • ja-JP: Japanese
  • ko-KR: Korean
  • ms-MY: Malay
  • nb-NO: Norwegian
  • pl-PL: Polish
  • pt-BR: Portuguese (Brazil)
  • pt-PT: Portuguese (Portugal)
  • ro-RO: Romanian
  • ru-RU: Russian
  • sk-SK: Slovak
  • es-MX: Spanish (Mexico)
  • es-ES: Spanish (Spain)
  • sv-SE: Swedish
  • th-TH: Thai
  • tr-TR: Turkish
  • uk-UA: Ukrainian
  • vi-VN: Vietnamese

For example, in your request to the create a payment page endpoint, you could change the button’s style, color and language:

"paymentMethods":{
  ...
  "settings":{
    "applepay":{
      "buttonType":"support",
      "buttonStyle":"white-outline",
      "language":"ca-ES"
    }
  }
}

Prefill fields with Apple Pay

Prefilling payment fields is covered in the Hosted Payment Pages Quickstart.

Was this page helpful?