Developer / Tech Guides

Developer guides to get you started and information on functionality that Payrix Integrated offers and how to implement them into your integrated application.

This page includes information on how to get started to accept payments and relatively common questions that arise during development and testing. To begin testing, reach out to your Partner Manager and a Sandbox test account and test API credentials can be set up and supplied to you.

For integration support enquiries, please email customerintegration@payrix.com.au

Accepting Payments

Payrix offers multiple payment solutions to integrate into your application. To help you get started, refer to the payment solution you wish to implement to guide you through the API flows for each scenario and how you can integrate the API into your application.

Payrix Hosted Payment Page

Benefits of implementing Payrix Hosted Payment Page

PCI Level 1 Compliant
Built-in captcha, PayTo/PayID and Wallet Payment acceptance and 3D-Secure Authentication
Payrix provide payment receipts, eDDR confirmation and PayTo Agreement
Ability to customise payment page with company colours and logo
Implemented through a re-direction to a Payrix Hosted domain

Payrix Hosted Payment Page (HPP)

Accepts payment via Card, PayTo/PayID and Wallet (Apple Pay or Google Pay)
- can be set to single one-time payment with no intention to save payer data
- OR supply the ‘savepayer’ paramater set to ‘true’ to save payer data to Payrix secure vault for ongoing payments
Does not accept BPAY payment
Payment submitted in real-time with real-time response

Note - Wallet Payment only available for single one-time payment

Payrix Hosted electronic Direct Debit Request (eDDR)

The purpose of an eDDR is to obtain the payment method and authority to debit payment from the customers nominated account
Accepts either Card or Bank Account as payment method
Payment is NOT submitted in real-time
Submit debit schedule via API (date and amount specified in API body request)

Partner Managed Payment Page

Benefits of implementing Partner Managed Payment Page

JavaScript library provided by Payrix
Provides a seamless and friendly customer journey
No need for a re-direction to a Payrix Hosted Page
Ability to white-label Payrix
Partner has full control over payment page appearance and styling

Accept Card payments through Partner Managed Payment Page (JavaScript)

Accept payments via Card by tokenising the card data using our JavaScript library
- can be implemented to process a single one-time tokenised transaction
- OR supply the ‘savepayer’ parameter set to ‘true’ to save payer data to Payrix secure vault for ongoing payments
- OR simply save payment method to payer record for future payments

Refer to our eDDR and Payment Page Requirements when your application is intending to save payment data to the Payrix Vault

Accept BANK payments through Partner Managed Payment Page

Collect Bank Account payment method to process Bank Account debits via Payrix Scheduling API

Refer to our eDDR and Payment Page Requirements when your application is intending to save payment data to the Payrix Vault

Useful features when testing your Payrix Integrated application

Test Declines in Sandbox
It is imperative that your application is capable of correctly identifying failed transactions. To ensure you have a workflow in place for failed transactions, use our rejection function when testing and developing your integrated application.

Self-Service function in Payrix Sandbox Environment
When testing payments in the Payrix Sandbox Environment, take advantage of our Self-Service function feature below which is found on the home page of your Sandbox Portal Account. This gives you the ability to run debit processing and the settlement process immediately.

Extra functionality

Please be aware certain functionalities (3DS, Fee Profiling, Custom Disbursements to name a few) are not enabled on the Sandbox Account by default. If you require these features, reach out to your Partner manager and customerintegration@payrix.com.au to have your account updated in Sandbox.

When you are nearing completion of the integration, ensure to reach out to your Partner manager and our Integration team (customerintegration@payrix.com.au).

To understand the process of moving your integration to live production, see our Integration Sign-Off Process and Integration Sign-Off Key Points.