Apple / Google Payments
Pay Advantage seamlessly integrates Apple and Google Payments into your platform. Our guide will walk you through the setup process for using these payment methods via iFrames and Payment Links, ensuring a smooth and secure transaction experience for your customers.
Initial Steps
Apple and Google payment options are enabled by default via our sandbox environment to allow testing integration with your own testing environment. https://test.payadvantage.com.au/SignIn
Please Note: To start using Apple and Google Pay in your production environment it is not available to end users by default and must be done by emailing a request to our support team [email protected].
If you are using the wordpress plugin or the iframe you will need to host a file provided to you by Pay Advantage on your domain and we will need to add your domain name to our supplier list. Please mention where you intend to use Apple and Google pay to our support team when you request access.
Payment requests offer a simple yet powerful hosted solution to direct your customers towards making payments. These links can be uniquely generated to facilitate various types of payments, ensuring flexibility and ease.
Once Apple and Google payments have been enabled on our account, payment requests will automatically display apple and google payment options (depending on the customers browser).
Please Note: Apple payments require a minimum of Safari 17 to display the button to the customer.
Creating a Payment Link
To create a payment link follow these steps:
- If a customer doesn't exist, you will need to create one: https://docs.payadvantage.com.au/reference/customers_post
- Link to an existing customer by setting either the customer.code or externalid fields. Make sure that these values are unique to avoid potential issues.
- As long as
credit_cardis passed into the payment options parameters, Apple and Google will display.
iFrame integration provides an embedded payment form directly on your site, offering a seamless customer experience without redirections to external payment pages.
The full documentation for creating the iframe request and registering the Apple and Google specific events, view here: https://docs.payadvantage.com.au/docs/capture-cards-with-iframe
Alongside the credit card setup, the specific event listeners you will need to handle for Apple and Google Payments are below:
"device-complete" - When a payment through Apple or Google is successfully processed, there's no need to execute the authorize function because the payment is already complete. In such cases, your main task is to manage the event that provides a charge response. This response is presented as a parameter object named AuthorizePaymentResponse, which is identical to the object you receive from calling PayAdvantageCreditCardCapture.authorize().
"device-error" - If an apple or google payment has been initiated, but received an error specific to the native paysheet or initialization, then this event is provided to allow an error to be displayed.
Checking Payment Status
Once a payment has changed status, you will be notified via a webhook event with either payment.created or payment.failed.
Once the payment has been created, you will then receive a webhook once that payment has settled (payment.settled). This is sent each time a payment settles. Please note that a payment can still fail after it has settled due to a chargeback.
Apple and Google payments are by nature a credit card charge, but will have a payment type of apple_pay and google_pay
INFO: A release in 8.17.0 will extend the functionality of retrieving a charge by external id to apple and google payments: https://docs.payadvantage.com.au/reference/credit_card_charges_get_by_external_id-1
Updated 6 months ago