Westpac Online Pay

Westpac Online Pay is a payment provider that integrates directly with StoreConnect. It is powered by Verifone Cloud, which provides the secure card capture and wallet infrastructure behind the integration. You can use Westpac Online Pay for:

• Standard checkout payments
• Subscriptions and updating subscription billing
• Additional and Salesforce payments
• Pre-authorization
• Google Pay and Apple Pay wallets
• Express checkout
• 3D Secure 2 (3DS2) authentication on card payments

Already have your credentials? Go to Configure Westpac Online Pay in StoreConnect.

What you need

• A Westpac Online Pay account with access to Verifone Central
• Your Verifone Central User ID and API Key
• A Payment Provider Contract set up in Verifone Central
• A secure card capture key (PGP public key) generated in Verifone Central
• For 3D Secure: a 3DS contract set up in Verifone Central (separate from your payment provider contract)
• For Google Pay: a Google Merchant ID from the Google Pay & Wallet Console
• For Apple Pay: an Apple Developer account

Get your Westpac Online Pay credentials

Westpac Online Pay credentials are managed in Verifone Central.

User ID and API Key

1. In Verifone Central, go to My Account.
2. Copy your User ID — this is your API Key in StoreConnect.
3. Go to API Keys.
4. Copy your API Key — this is your API Secret in StoreConnect.

Payment Provider Contract

1. In Verifone Central, go to Administration > Payment Provider Contracts.
2. Select your contract.
3. Copy the contract ID — this is your payment_contract_id.

Secure card capture key

The secure card capture key is a base64-encoded PGP public key that Verifone uses to encrypt card details. Generate it in Verifone Central and note both the key value and its alias — these are your secure_card_capture_key and secure_card_capture_key_alias.

Configure Westpac Online Pay in StoreConnect

1. Open StoreConnect and go to Setup > Payments > Payment Providers.
2. Select New. Complete the fields as follows, then Save:

StoreConnect field	Westpac Online Pay value
Name	Westpac Online Pay. For testing, add - Sandbox.
Provider	Select WestpacOnlinePay from the list
API Mode	sandbox or production
API Key	Your Verifone Central User ID
API Secret	Your Verifone Central API Key
API Options	See below

Set up the API Options field

The API Options field is where you provide the required contract and card capture details, and where you enable optional features such as wallets and subscriptions.

:::note The API Options field uses YAML format. Each option goes on its own line. :::

Required options

Every Westpac Online Pay provider needs the following:

```yaml

payment_contract_id: a1b2c3d4-5678-9abc-def0-123456789abc secure_card_capture_key: LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0t… secure_card_capture_key_alias: A12345 georegion: au ```

• payment_contract_id: Found in Verifone Central under Administration > Payment Provider Contracts.
• secure_card_capture_key: The base64-encoded PGP public key generated in Verifone Central.
• secure_card_capture_key_alias: The alias for your secure card capture key.
• georegion: The regional Verifone Cloud endpoint your account uses.

Determining your georegion

The georegion value selects which regional Verifone Cloud endpoint StoreConnect connects to. It is not shown directly in Verifone Central, so:

1. Check with your Verifone account manager or support team.
2. Use the value for your geographic market:
   • au — Australia / Asia Pacific
   • eu — Europe / EMEA
   • us — North America
   • nz — New Zealand
3. If the value is incorrect, your API calls will fail — test to confirm.

If georegion is not set, StoreConnect defaults to au.

Enable 3D Secure (3DS2)

3D Secure 2 (3DS2) adds a cardholder authentication step to card payments. It helps prevent fraud and can shift chargeback liability to the card issuer. Depending on the card and issuer, authentication is either frictionless (verified in the background) or a challenge, where the customer confirms the payment with their bank — for example, by entering a one-time code.

3DS2 applies to standard card payments and to updating subscription billing. It is not used for Apple Pay and Google Pay, which carry their own scheme-level authentication.

Before you start

You need a 3DS contract set up in Verifone Central. This is separate from your payment provider contract and has its own contract ID. Contact your Westpac Online Pay or Verifone account manager if you do not have one.

Enable 3DS in StoreConnect

Add the following to the API Options field:

```yaml

three_d_secure: true threeds_contract_id: b2c3d4e5-6789-abcd-ef01-23456789abcd ```

• three_d_secure: Set to true to require 3DS2 authentication on card payments.
• threeds_contract_id: Your Verifone 3DS contract ID.

:::warning threeds_contract_id is required when three_d_secure is enabled — if it is missing, card payments will fail. It is a separate value from payment_contract_id; do not reuse the payment provider contract ID here. :::

Enable subscriptions

To use Westpac Online Pay for subscription billing, add a subscription token scope to the API Options field:

```yaml

subscription_token_scope: a1b2c3d4-e5f6-7890-abcd-ef1234567890 ```

:::note Wallet payments (Apple Pay and Google Pay) are not currently supported for subscriptions. Subscriptions are billed using saved card details. :::

Enable Google Pay and Apple Pay

Westpac Online Pay supports Google Pay and Apple Pay through Verifone’s wallet infrastructure.

Enable wallets in Verifone Central

1. Log into your Verifone Central account.
2. Go to Administration > Wallets.
3. Select your organization from the dropdown.
4. Select Add new wallet.
5. Add both the Apple Pay and Google Pay wallets.

:::note Create the wallets on the same organization as your Payment Provider Contract, or they will not be available to the integration. :::

Enable wallets in StoreConnect

Add the following to the API Options field:

```yaml

show_wallets: true express_checkout_enabled: true ```

show_wallets displays the wallet buttons at the payment stage of checkout. express_checkout_enabled also displays them on product pages, the cart page, and the cart dropdown (except for bundled products).

Then complete the setup below for each wallet.

Google Pay setup

1. Go to the Google Pay & Wallet Console and create a merchant account if you don’t already have one. Note your Merchant ID from the top menu — it looks like ABC2DEF4GHIJK.
2. In Verifone Central, go to Administration > Payment Provider Contracts, select your contract, and note the Merchant ID processor details value.
3. Add the following to the API Options field in StoreConnect:

```yaml

merchant_id: 12345678 merchant_country_code: AU google_merchant_name: ‘Your Store Name’ google_merchant_id: ‘ABC2DEF4GHIJK’ ```

• merchant_id: The Merchant ID from your Payment Provider Contract.
• merchant_country_code: Your two-letter store country code (for example, AU, US, NZ).
• google_merchant_name: The display name shown to customers during Google Pay checkout.
• google_merchant_id: Your Google Pay & Wallet Console Merchant ID.

To test, open your store in Chrome. The Google Pay button appears on product pages, the cart page, and the final payment page of checkout.

Apple Pay setup

1. In the Apple Developer Console, go to Certificates, Identifiers & Profiles > Identifiers > Merchant IDs and note your Apple merchant ID — it looks like merchant.com.example.merchantname.
2. In Verifone Central, go to Administration > Wallets and add an Apple Pay wallet using your Apple merchant ID. Enable the Apple Pay for web via direct API checkbox.
3. Register your store domain:
   • In the Apple Developer Console, go to your Merchant ID and select Add Domain.
   • Enter your store domain and download the verification file Apple provides.

   • Add the file contents to the API Options field in StoreConnect:

     ```yaml

     applepay_verification: |- (paste the contents of the Apple verification file here) ```

   • In Verifone Central, select Verify domain.

4. Once verification is complete, copy the Wallet ID shown in Verifone Central (a UUID such as 12345678-abcd-1234-efgh-567890abcdef) and add it to the API Options field as your apple_merchant_id:

   ```yaml

   apple_merchant_id: 12345678-abcd-1234-efgh-567890abcdef ```

5. Remove the applepay_verification key from the API Options field — it is only needed during initial domain registration.

:::note StoreConnect serves the verification file automatically at https://yourstorename.com/.well-known/apple-developer-merchantid-domain-association while applepay_verification is present in the API Options field. :::

To test, open your store in Safari. The Apple Pay button appears on product pages, the cart page, and the final payment page of checkout.

Sandbox and production

Set the API Mode field to sandbox for testing and production when you go live. StoreConnect connects to Verifone’s test endpoints in sandbox mode and to your regional production endpoint in production mode. Use the matching credentials and contract details for each environment.

Example — complete API Options:

```yaml

payment_contract_id: a1b2c3d4-5678-9abc-def0-123456789abc secure_card_capture_key: LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0t… secure_card_capture_key_alias: A12345 georegion: au three_d_secure: true threeds_contract_id: b2c3d4e5-6789-abcd-ef01-23456789abcd subscription_token_scope: a1b2c3d4-e5f6-7890-abcd-ef1234567890 show_wallets: true express_checkout_enabled: true merchant_id: 12345678 merchant_country_code: AU google_merchant_name: ‘Your Store Name’ google_merchant_id: ‘ABC2DEF4GHIJK’ apple_merchant_id: 12345678-abcd-1234-efgh-567890abcdef ```

:::note Only include the options for the features you have set up. For example, if you are not using subscriptions, omit subscription_token_scope; if you are not using wallets, omit the wallet and Apple/Google Pay options, etc. :::