Manage BPAY Investigation
A simple way to create and manage your BPAY Payment investigations.
Whether you are acting on behalf of a Payer or a BPAY Biller, this API lets you integrate your existing back office systems with our BPAY investigations management services, making the entire process far more efficient.
This API supports mistaken payment, unauthorised payment and payment trace investigations.
How this can help your business
Faster return of funds through improved upstream operational processing.
Remove the need for your teams to use the BPAY Operations Portal to create and manage BPAY Payment Investigations.
Directly connect your operational systems to the API for efficient handling of BPAY Payment Investigations.
Eligibility
In order to use the BPAY Group APIs, other criteria must be met, such as providing an ACN, ABN or ARBN.
For full requirements, please see the Production Request.
For more information on how your organisation can access the APIs, check your Eligibility.
Approved Purpose
Use as an alternative to the BPAY Operations Portal to create and manage BPAY Payment Investigations.
Integrating the API directly into self-service banking systems to enhance existing functionality or create new functionality for customers.
Integrating the API directly into Member operational systems to enhance existing functionality or create new functionality for team members.
Endpoints
All Payment Investigations
GET /paymentinvestigations/{investigationId}
Retrieve the details associated with a specified Payment Investigation
POST /paymentinvestigations/{investigationId}/comments
Add a comment to a Payment Investigation
GET /paymentinvestigations/updates
Retrieve all payment investigations that have been updated since the last request
Mistaken Payment Investigations
POST /mistakenpaymentinvestigations
Create a Mistaken Payment Investigation
POST /mistakenpaymentinvestigations/{investigationId}/actions/resolve
Resolve a Mistaken Payment Investigation
POST /mistakenpaymentinvestigations/{investigationId}/actions/convertandclose
Convert a resolved Mistaken Payment Investigation into an Error Correction and close the Investigation
POST /mistakenpaymentinvestigations/{investigationId}/actions/close
Close a Mistaken Payment Investigation
POST /mistakenpaymentinvestigations/{investigationId}/actions/withdraw
Withdraw a Mistaken Payment Investigation
POST /mistakenpaymentinvestigations/{investigationId}/actions/reopen
Reopen a Mistaken Payment Investigation
Unauthorised Payment Investigations
POST /unauthorisedpaymentinvestigations
Create an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/acknowledge
Acknowledge an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/addrecipient
Add recipient details and funds availability to Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/editrecipient
Edit the recipient details of an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/resolve
Resolve an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/convertandclose
Convert a resolved Unauthorised Payment Investigation into an Error Correction and close the Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/close
Close an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/withdraw
Withdraw an Unauthorised Payment Investigation
POST /unauthorisedpaymentinvestigations/{investigationId}/actions/reopen
Reopen an Unauthorised Payment Investigation
Payment Trace Investigations
POST /paymenttraceinvestigations
Create a Payment Trace Investigation
POST /paymenttraceinvestigations/{investigationId}/actions/resolve
Resolve a Payment Trace Investigation
POST /paymenttraceinvestigations/{investigationId}/actions/close
Close a Payment Trace Investigation
POST /paymenttraceinvestigations/{investigationId}/actions/withdraw
Withdraw a Payment Trace Investigation
POST /paymenttraceinvestigations/{investigationId}/actions/reopen
Reopen a Payment Trace Investigation
Branding Requirements
A BPAY logo or wordmark needs to be used where this API is consumed.
Refer to the Brand Guidelines for more information.