Westpac

Westpac PayWay is a payment gateway that processes credit card transactions for Australian merchants. Use this integration to accept credit card payments at checkout, process invoice payments, and optionally store customer payment methods for future use.

How to set it up

Where to find it: Admin → Settings → Payments → Westpac

When you'd use this: You're an Australian business that wants to accept credit card payments through Westpac's PayWay gateway.

What you need first:

• An active Westpac PayWay merchant account
• Your Publishable API Key from PayWay
• Your Secret API Key from PayWay
• Your Merchant ID from PayWay

Set it up:

1. Navigate to Admin → Settings → Payments
2. Select Westpac from the available payment providers
3. Enter your Publishable API Key in the publishableApiKey field
4. Enter your Secret API Key in the secretApiKey field
5. Enter your Merchant ID in the merchantId field
6. Save the configuration
7. Test the integration by processing a small test transaction

Configuration options

Field	What it does	Default	Required
publishableApiKey	Public API key used for client-side tokenization of card details	(empty)	Yes
secretApiKey	Secret API key used for server-side API authentication, combined with Basic auth	(empty)	Yes
merchantId	Your PayWay merchant identifier, included in all transaction requests	(empty)	Yes

Using it day-to-day

For customers at checkout:

1. Customer selects credit card as their payment method
2. Customer enters their card details or selects a previously saved card
3. If saving the card, customer checks the "Save for future use" option
4. Card details are tokenized using the publishable API key
5. Payment is processed (either pre-authorized or captured immediately depending on site configuration)
6. Customer receives confirmation once payment is approved

For admins processing invoice payments:

1. Navigate to the invoice requiring payment
2. Select the Westpac payment method
3. Either enter new card details or use a customer's stored payment method
4. Process the payment
5. If pre-authorization is enabled, capture the payment separately when ready to fulfill

For recurring billing and saved cards:

1. Customers can manage saved cards through their account self-service area
2. Admins can verify stored cards using the account verification transaction type
3. Saved cards are referenced by customerNumber in subsequent transactions

Troubleshooting

Payment shows as successful but invoice still marked unpaid

• Cause: Payment synchronization issue between PayWay and your ERP system
• Fix: Check the order/invoice sync status in Admin. Manually trigger a sync if needed, or verify the payment was captured (not just pre-authorized)

Pre-authorized payment not capturing automatically

• Cause: Site is configured for pre-authorization but automatic capture is not enabled for invoice payments
• Fix: Either manually capture the pre-authorization through the order/invoice screen, or enable automatic capture for invoice payments in your payment configuration

Saved credit card not working for customer

• Cause: Card may have expired, been deleted, or failed verification
• Fix: Have the customer re-enter and save their card details. Use the verifyStoredCard operation to test stored cards before charging

Customer IP address required error

• Cause: PayWay requires customerIpAddress for fraud prevention on all transaction types
• Fix: Ensure your site is capturing and passing the customer's IP address with all payment requests. Check network/proxy configuration if IP is not being forwarded correctly

Authorization header authentication failing

• Cause: Secret API key is incorrect or not properly encoded for Basic authentication
• Fix: Verify the secretApiKey in your configuration matches your PayWay account. The system automatically encodes credentials for Basic auth using the format in message_headers