Payments2Us ManualsPayments2Us User ManualBPAYHow to setup BPAY API Credentials

How to setup BPAY API Credentials

1. Register and Login for developer access

Navigate to the BPAY Portal site: and register

2. Create an App

  1. After logging in, click on the drop down menu arrow next to your username
  2. Select "Apps" and create a new one
  3. Enter{Yourcomanyname}Payments2Us and Save

3. Complete the Onboarding Request

From the Onboard menu, select Onboarding Request:

  • You will need to have access to: Generate BPAY CRN
  • Your organisation would likely be: BPAY Scheme Participants

Should you have questions about the BPAY On-boarding process, first check the BPAY Support Q&A.  Please do NOT contact our support as we are NOT BPAY - This is a different organisation to us.  The access to the API's and on-boarding process is outside of our control.

We do know the on-boarding process is NOT automatic/instantaneous and you will need to await the details from BPAY Operations.

4. After your onboarding is approved, enter credentials into Salesforce

4.1. Pre-production vs. Production

When BPAY first responds, they are likely to provide you with a Pre-production key.  This key begins with BPPC.

From version 9.4 (approx late Feb 2023) onwards, you can use this key with the "Environment" field on the Merchant Facility is set to "Sandbox".

For Production, you will need to ensure with BPAY that you have the Production Keys.  This will likely require a separate request to BPAY.

  1. Production Keys begin with : BPP- and MUST be used with the Environment on the Merchant Facility set to Production
  2. Pre-Production Keys begin with BPPC- and MUST be used with the Environment on the Merchant Facility set to Sandbox

4.2. Check Generate CRN Enabled

Ensure the "Generate BPAY CRN" is enabled in your BPAY Portal.  Please note that "Sandbox Generate BPAY CRN" is NOT correct.

4.3. Locate your BPAY Key and Secret

Log back into the BPAY Developer Portal

  1. From the drop down menu item by your username - select Apps
  2. Then select the App you added previously
  3. If no API Keys exist, press "Add Keys" button
  4. You will copy the key for entry into Salesforce
  5. You will copy the Secret for entry into Salesforce

4.4. Updating Salesforce with BPAY App Key/Secret

In Salesforce, locate the Primary Active Merchant Facility

Then update the BPAY API Key and BPAY API Secret fields that were copied from the previous step.

We do recommend updating all Merchant Facilities to have these details active, but as a minimum the primary/active needs to have these details entered.

If you cannot locate these fields on the page, ask your Salesforce administrator to add them to the page layout.

Make sure the correct key is copied.  Please see Pre-production vs. Production.

Also make sure the Environment setting on the Merchant Facility matches the Pre-production vs. Production.

Please review step Pre-production vs. Production above