Reports

Reports

The following reports are available:

  • Daily Transaction Report
  • MT940 (for select customers only, by request)
📘

Encryption of Daily Transaction Reports

The option to enhance the security of Daily Transaction Reports through PGP Encryption is now available. Please note that this feature is not enabled by default; however, it can be configured for your account upon request. To initiate the encryption setup, kindly submit a support ticket with our team.

Downloading reports using the dashboard

All reports are accessible via the dashboard:

  1. Login to the dashboard
  2. Navigate to Reports in the left navigation bar
  3. Download the report you are looking for

Note: Using the dashboard, only the last 3 months of reports can be accessed. However, the API will provide you access to the full set of reports.

Custom date range reports

Custom date range reports allow users to enter specific dates e.g. 11/10/2023 to 20/10/2023 in order to download a report covering that period.
Please note that there is a maximum limit of 12,000 transaction records that will be returned for any given period.


Daily Transaction Report

The Daily Transaction Report is a comprehensive report containing all your transaction activity between 12am - 11:59pm each day, similar to a bank statement. It contains all inflows and outflows to your account.

Transaction matching for refunds, returns and other flow of fund updates on a transaction.

Azupay will attempt to match any inflows and outflows caused by a future event on the transaction with the original transaction, such as a Refund on a Payment Request. In some circumstances, such as with payments returned via a third party without correct metadata, this matching does not always occur. When a future event occurs against the original transaction, a new transaction will be entered into the daily transaction report. To assist with reconciliation, the same transaction type will be used alongside the original transaction identifiers such as TransactionId or clientTransactionId, but the CR or DR field will be updated if the flow of funds has changed, and a new NPPTransactionId will be mapped against the new transaction.

Filename format

YYYY-MM-DD-DAILY_TXN_V2.csv; where YYYY is the year, MM is the month and DD is the date of the month. Example: 2022-01-18-DAILY_TXN_V2.csv

Generation time

File is generated daily at 6:15PM GMT.

Field Separator

Fields are separated by the pipe symbol |

Line Separator

Lines are separated by a new line character \n

Field specifications

Field

Format

Description

Min Length

Max Length

Nullable

DateTime

String (ISO8601 simplified extended)

No

LocalTime

String (ISO8601)

Australia/Sydney time (AEST/AEDT)

No

CRDR

Enum ['CR', 'DR']

CR credit or DR debit transaction

No

Amount

Currency

No

Balance

Currency

The balance after the transaction was processed

No

TransactionType

Enum ['Payment', 'PaymentRequest', 'Topup', 'Sweep', 'PaymentInitiation']

No

Bsb

String

6

6

Yes

AccountNumber

String

6

12

Yes

AccountName

String

5

50

No

PayId

String

5

50

Yes

PayIdType

Enum ['PHONE', 'EMAIL', 'ABN', 'ORG']

Yes

PaymentDescription

String

All references to special characters have been removed (only from reports i.e. pipe, line feed, quotation marks and carriage return)

5

280

No

PayerPaymentReference

String

Reference provided by the PayID payer on their web/mobile banking

Yes

TransactionId

String

The unique transaction identifier generated by the API

5

200

No

ParentTransactionId

String

Currently corresponds to the PaymentRequest.PaymentRequestStatus.parentPaymentRequestId or PaymentInitiation.paymentAgreementId for PayTo transactions

5

200

Yes

ClientTransactionId

String

The unique Id provided by the consumer of the API

5

100

Yes

NPPTransactionId

String

The unique identifier for the transaction within the NPP infrastructure

35

35

Yes

*ClientBranch

String

Additional data point that can be used to identify a transaction - provided by client. *Available only by request to Azupay Service desk, will appear at the end of report after previous field in the table

5

50

Yes

*SentViaDE

Enum ['true']

Indicates if an outbound payment was routed via DE instead of settling via NPP rails. *Available only by request to Azupay Service desk, will appear at the end of report after previous field in the table

Ye


📘

*Note: Clients can request to configure the 'Client Branch' field in the paymentRequest API and use the information in it as an additional payment transaction data point. If a client passes data into the 'Client Branch' field, it can also be shown in the Daily Transaction report via special request a ticket through the Azupay Service Desk. 'SentViaDE' is also only available upon special request to Azupay Service desk


Customising the daily transaction report

Client dashboard users can specify the fields they want to see in their daily transaction report.

In order to customise the daily transaction report, dashboard users should do the following:

  • Login in to the Azupay client dashboard and navigate to 'Settings' page
  • Scroll down to the section called 'Daily transaction report'
  • In the 'Selected Field' dropdown, review currently enabled fields in this list and click to unselect. To add fields to your report, click on unselected fields so that they become highlighted
  • Select the time you wish the daily transaction report to be generated (either 1:00am or 5:15am day T+1)
  • Click on 'Save' button


If no preferences are set on this page, the daily transaction report generated daily for you will show these default fields:

  • DateTime
  • LocalTime
  • CRDR
  • Amount
  • Balance
  • TransactionType
  • BSB
  • AccountNumber
  • AccountName
  • PayId
  • PayIdType
  • PaymentDescription
  • PayerPaymentReference
  • TransactionId
  • ParentTransactionId
  • ClientTransactionId
  • NPPTransactionId

Other fields that can be added to your daily transaction report are:

  • Client Branch
  • Sent Via DE
  • Serial Number
  • Settled By

How are refunds displayed on the daily transaction report?

The daily transaction report will show all inflows of payments into your account as CR (credits), and all outflows of transactions of as DR (debits). Depending on the transaction type, an inbound payment may be returned or refunded to clients. In this case

Example of how payment request refunds will display

A PaymentRequest refund occurs against a payment request. The original inbound payment request will remain in the transaction report on the original date it was processed (represented as a CR in the CRDR field), and an additional outbound transaction will be populated into the report at the date time the refund was processed (represented as a DR in the CRDR field). This new transaction will contain all of the data of the original request with the following two exceptions:

  • The amount may be less than the original payment request in the case of a partial refund.
  • The NPPTransactionId will different.

Sample of a refund on a Payment Request.

DateTime|LocalTime|CRDR|Amount|Balance|TransactionType|BSB|AccountNumber|AccountName|PayId|PayIdType|PaymentDescription|PayerPaymentReference|TransactionId|ParentTransactionId|ClientTransactionId|NPPTransactionId
2022-06-17T00:05:21.000Z|2022-06-17 10:05:21 GMT+10|CR|5.00|410.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|a75bd89b6f8bc8c04c41a35f99e05c3c||yrirzaalok8ivb82hqk5|BZTPAU22XXXN20220617500000000002050
2022-06-17T00:10:21.000Z|2022-06-17 10:10:21 GMT+10|DR|5.00|405.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|a75bd89b6f8bc8c04c41a35f99e05c3c||yrirzaalok8ivb82hqk5|BZTPAU22XXXN20220617500000000004677

Sample

DateTime|LocalTime|CRDR|Amount|Balance|TransactionType|BSB|AccountNumber|AccountName|PayId|PayIdType|PaymentDescription|PayerPaymentReference|TransactionId|ParentTransactionId|ClientTransactionId|NPPTransactionId
2022-06-17T00:04:37.000Z|2022-06-17 10:04:37 GMT+10|CR|100.00|100.00|Topup||||[email protected]|EMAIL|Topup Description|Payer payment reference|AZTPAU22XXXN20220617300000000001661|||AZTPAU22XXXN20220617300000000001661
2022-06-17T00:04:41.000Z|2022-06-17 10:04:41 GMT+10|DR|20.00|80.00|Payment|||John-Smith Doe|[email protected]|EMAIL|Payment for wages August 2020||c241b3eece995b38e2d5b79391ded2be||1541e2f0-edd1-11ec-bc15-d1127cd0936e|BZTPAU22XXXN20220617100000000001680
2022-06-17T00:04:42.000Z|2022-06-17 10:04:42 GMT+10|DR|30.00|50.00|Payment|062000|12345678|John-Smith Doe|||Payment for wages August 2020||abb9527055f6461815ea6f16c144b95f||1611b610-edd1-11ec-bc15-d1127cd0936e|BZTPAU22XXXN20220617800000000001600
2022-06-17T00:04:43.000Z|2022-06-17 10:04:43 GMT+10|DR|40.00|40.00|Payment|062000|12345444|John-Smith Doe|||Payment for wages August 2020||c4058276027dea80b8b78041466aab33||16d0c050-edd1-11ec-bc15-d1127cd0936e|BZTPAU22XXXN20220617300000000001750
2022-06-17T00:04:43.000Z|2022-06-17 10:04:43 GMT+10|CR|30.00|80.00|Payment|062000|12345678|John-Smith Doe|||Payment for wages August 2020||abb9527055f6461815ea6f16c144b95f||1611b610-edd1-11ec-bc15-d1127cd0936e|BZTPAU22XXXN20220617800000000001600
2022-06-17T00:04:45.000Z|2022-06-17 10:04:45 GMT+10|CR|40.00|80.00|Payment|062000|12345444|John-Smith Doe|||Payment for wages August 2020||c4058276027dea80b8b78041466aab33||16d0c050-edd1-11ec-bc15-d1127cd0936e|CUSCAU2SXXXN20220617300000000001771
2022-06-17T00:04:46.000Z|2022-06-17 10:04:46 GMT+10|CR|30.00|110.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|0791daa0510cad2f71a3d35ae3e743d0||bkbxcy1lnxzxqohqh70u|AZTPAU22XXXN20220617200000000001351
2022-06-17T00:04:52.000Z|2022-06-17 10:04:52 GMT+10|CR|95.00|205.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|3b6a90748ddb718eff97b4bd056e21d9|e10ad2f0bd58377a556b24459723d2d9|1c578bd0-edd1-11ec-b843-bf02934eddb8|AZTPAU22XXXN20220617400000000002011
2022-06-17T00:04:55.000Z|2022-06-17 10:04:55 GMT+10|CR|25.00|230.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|8170b769a45650522e08b97e08fbc86c|f8f065b02ad2e96458e5e99936f23ac6|1e328d60-edd1-11ec-b843-bf02934eddb8|AZTPAU22XXXN20220617100000000001811
2022-06-17T00:04:57.000Z|2022-06-17 10:04:57 GMT+10|CR|25.00|255.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|278ca38942e96a4f6a25fb0c5999a10b|f8f065b02ad2e96458e5e99936f23ac6|1f6abf40-edd1-11ec-b843-bf02934eddb8|AZTPAU22XXXN20220617700000000002251
2022-06-17T00:05:00.000Z|2022-06-17 10:05:00 GMT+10|CR|60.00|315.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|a75bd89b6f8bc8c04c41a35f99e05c3c||yrirzaalok8ivb82hqk5|AZTPAU22XXXN20220617700000000002271
2022-06-17T00:05:07.000Z|2022-06-17 10:05:07 GMT+10|CR|100.00|415.00|PaymentInitiation|||name|[email protected]|EMAIL|The description||869398e7e8cab0c84c826a210135a3d5|d00b985055c20190d5ad64bc49126328|24749290-edd1-11ec-bc15-d1127cd0936e|BZTPAU22XXXN20220617000000000001681
2022-06-17T00:05:21.000Z|2022-06-17 10:05:21 GMT+10|DR|5.00|410.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|a75bd89b6f8bc8c04c41a35f99e05c3c||yrirzaalok8ivb82hqk5|BZTPAU22XXXN20220617500000000002050
2022-06-17T00:05:28.000Z|2022-06-17 10:05:28 GMT+10|DR|30.00|380.00|PaymentRequest|802010|00000001|Payer details Name|[email protected]|EMAIL|Integration test payment|Payer payment reference|0791daa0510cad2f71a3d35ae3e743d0||bkbxcy1lnxzxqohqh70u|AZTPAU22XXXN20220617900000000001710
2022-06-17T00:05:40.000Z|2022-06-17 10:05:40 GMT+10|DR|380.00|0.00|Sweep|802010|00000001|Account name|||Funds held by Azupay||AZUPAYOUTSWEEP-2D9A890D-20220617||AZUPAYOUTSWEEP-2D9A890D-20220617|BZTPAU22XXXN20220617900000000001760

Backwards compatibility

To ensure backwards compatibility as we introduce more data to this report, we recommend implementing parsing which follows these rules:

  • Do not rely on columns of data appearing in a particular order.
  • Assume that we will add columns to the report in the future

SFTP upload and notification

As an extra feature, we can also upload the file to a sftp server and send a notification email. To know more about this feature contact support to configure the sftp and email parameters.

Uploading daily transaction reports to your SFTP server

You can specify the configuration details of the SFTP server where Azupay can upload your daily transaction report.

To specify the configuration details of the SFTP server for your daily transaction report:

  • Login to the Azupay client dashboard
  • Click on 'Settings' and scroll down the section called 'Daily Transaction Report'
  • In the section labelled 'Upload generated reports to your SFTP server', add in details for the following configuration fields: Host, Port, Username, Path, Notification email
  • Click on 'Save' button on the RHS of the page

MT940 reports

You can enable an MT940 report for transactions in the Reports section of the Azupay client dashboard.

To turn on MT940 reporting, ensure that you have the 'Enabled' checkbox ticked, select Version and Interval, before hitting 'Save' button to configure your MT940 report preferences.

For Interval settings, there are only 2 options to have your report generated: Hourly or Daily.

For Version settings, you can select "V1 (without PayID)" or "V2 (with PayID)". If "V2" is selected, Then the report includes the PayID value for each transaction in the record type 86 section.

Here is a sample of the report:

{1:A01AZTPAU22XXXX0000000000}{2:I940AZUPAYXXXXN}{3:{118:MT940950GEN}{4:
:20:MT94050GEN000000
:25:80201010000001
:28C:00021/12
:60F:C220121AUD0,00
:62F:C220121AUD0,00
-}{5:}
{1:A01AZTPAU22XXXX0000000000}{2:I940AZUPAYXXXXN}{3:{118:MT940950GEN}{4:
:20:MT94050GEN000000
:25:80201010000001
:28C:00021/12
:60F:C220121AUD0,00
:62F:C220121AUD0,00
-}{5:}