How to test with BPAY Sandbox APIs?

BPAY developers portal has moved from bpaygroup-portal.apigee.io to developers.auspayplus.com.au/bpay/. It now provides Sandbox APIs for initial testing and integration. These can be used alongside Pre-Production APIs within Payments2Us.

Pre-Production APIs vs Sandbox APIs

The Pre-Production APIs (also referred to as Non-Production or Certification APIs) are different from Sandbox APIs.

It is recommended to use Pre-Production APIs for BPAY testing. As they better reflect real-world behaviour.

1. Setup BPAY Sandbox APIs

Add the Remote Site Setting sandbox.api.bpaygroup.com.au and ensure it is activated in your Salesforce org
Add BPAY Sandbox API keys in your Merchant Facility.

2. Understanding BPAY Sandbox Limitations

The BPAY Sandbox environment is designed for basic connectivity testing and contains limited test data. The CRNs can only be generated using a specific test customer number: 123456 on Sandbox APIs. Payments2Us generates customer numbers dynamically (see How to setup CRNs in Payments2Us), which are not supported in the BPAY Sandbox environment.

During testing with Sandbox APIs, you will notice that the Payment Txns are created successfully, but an error log is generated with the message: “Unsupported Request Payload”. This error is expected and indicates that the BPAY APIs are successfully connected and working, but the request is not supported due to the limitations. You can safely ignore this error during Sandbox testing.

3. Use Non-Production APIs for Testing (Recommended)

For accurate and complete testing, use BPAY Pre-Production API keys (with the BPPC prefix), which better reflect real-world behaviour. You may need to contact BPAY Support to request access to the Pre-Production environment.

If you encounter errors other than “Unsupported Request Payload”, or have any questions, please contact Payments2Us Support for further assistance.

Need Help? Let's Find the
Answer Together!

Sorry, we didn't find any relevant articles for you.