What are the Reporting APIs?

The Reporting APIs allow access to data and insights within PTX. The APIs currently available in this service are the Bacs Reports API and Bacs Reports GraphQL API.

• Bacs Reports API - Offers an efficient and secure way to query and download reports, providing a range of parameters to filter reports and supports downloading reports in a range of formats.

• Bacs Reports GraphQL API - Uses GraphQL to provide access to detailed Bacs report data, including report items, groups, and reason codes. Unlike traditional APIs that return fixed sets of data, GraphQL API allows you to ask for exactly what data you need—no more, no less.

System Requirements

• Subscription to the PTX UK Payments Hub and Reporting module are required.
• Authentication is achieved using a secret key, generated by an API Client.

Bacs Reports

Bacs offer a wide range of reports to Service Users including Input, Rejection and Withdrawal Reports (confirmation of the successful receipt of a file) and exception reports that detail any failed payments, Direct Debit Mandates or changes to bank details. Reports can be downloaded directly from the Payment Services website or via PTX using a Smart Card, HSM Certificate or the Bottomline Bureau.

Bacs Reports API

Once downloaded to PTX, Bacs reports can be viewed directly in the application and exported in XML format. The Bacs Reports API makes it possible to download Bacs reports programmatically without the need for payment profiles that exist in the Payments modules of PTX.

Here is what you can do with our Bacs Reports API

Service User Numbers

Returns a list of Service User Numbers that are associated to any report that PTX has collected from the Payment Services website.

Reports

Returns a list of the Bacs reports that have been collected for a specified Service User Number. Use query parameters to filter results. The results will include details of the type of report (AUDDIS, ADDACS, etc), dates created and processed by Bacs, and a unique ID for each Bacs report.

Download Reports

Download the Bacs report using the unique ID assigned to each report. PTX will make available reports in XML or CSV format where provided by Bacs.

Here are the Bacs Reports you can retrieve through the API

Bacs Reports

• Arrival Report (2011)
• Rejection Arrival Report (2068)
• Input Report (2013)
• Rejection Input Report (2065)
• Test Input Report (2025)
• Withdrawal Report (2014)

Bacs Credit Reports

• AWACS Advice of Wrong Account for Credit Service (7007)
• ARUCS Automated Return of Unapplied Credit Service Report (1027/1028)

Bacs Debit Reports

• AUDDIS Bank Return API (7002)
• AUDDIS Acceptance Report (7003)
• AUDDIS Rejection Report (7004)
• ADDACS Report (7001)
• ARUDD Report (1016)

Direct Debit Indemnity Claim Reports

• DDICA (800509)
• DDIC Challenge and Response Report (1225)
• DDIC Requests Report (1226)
• DDIC Challenge Audit Report (1227)

Direct Corporate Access (Faster Payments)

• DCA Input Report

Bacs Reports GraphQL API

The Bacs Reports GraphQL API is a flexible and efficient way for our systems to access detailed Bacs report data.

The Bacs Reports GraphQL API enables precise, efficient access to detailed Bacs report data - such as report items, groups, and reason codes - by allowing systems to request only the specific data they need. This flexibility supports faster development, reduces unnecessary data transfer, and enhances the user experience by enabling tailored views based on user roles or permissions. As reporting needs evolve, the APIs adaptable structure ensures seamless scalability without disrupting existing integrations.

You can now generate a single report that includes all your SUNs for AWACS, or tailor your output by selecting specific SUNs and reason codes within a defined time frame - giving you greater flexibility and control over your reporting.

Here is what you can do with our Bacs Reports GraphQL API

Create queries

Users can query specific report items, groups, or reason codes without retrieving unnecessary information. This reduces data load and improves performance.

Report Items

Retrieve paginated report items based on provided filters across all SUNs, reason codes for customizable date ranges for each Bacs report type.

Report Groups

Retrieve all available Bacs report groups.

Report Reason Codes

Retrieve reason codes for a given report group with pagination.

Download Reports

Export custom queries in XML format.

Faster Development and Integration

Because GraphQL is self-describing and adaptable, developers can build and iterate on features faster. For example, if a new report format is introduced, it can be accessed without changing the underlying API structure.

Improved User Experience

This API can deliver tailored views of Bacs reports to users - showing only the relevant data based on their role or permissions.

Here are the Bacs Reports you can retrieve through the API

Bacs Credit Reports

• AWACS Advice of Wrong Account for Credit Service (7007)
• ARUCS Automated Return of Unapplied Credit Service Report (1027/1028)

Bacs Debit Reports

• AUDDIS Bank Return API (7002)
• AUDDIS Acceptance Report (7003)
• AUDDIS Rejection Report (7004)
• ADDACS Report (7001)
• ARUDD Report (1016)

Direct Debit Indemnity Claim Reports

• DDICA (800509)
• DDIC Challenge and Response Report (1225)
• DDIC Requests Report (1226)
• DDIC Challenge Audit Report (1227)