Search for transaction data

Transaction data includes payments received from Payment Requests and Payment Initiations as well as payments made out by PayOut. You can access this data as follows:

  1. Navigate to the Transactions view in the navigation bar
  2. You will be presented with a form where you can select from Payment Requests, Payment Initiations or Outbound Payment products
  3. You can specify additional search criteria such as PayID and / or dates to search by.
    1. Not all combinations of criteria are available for all transaction types, when a criteria is unavailable the field will be greyed out. If you need to search on a greyed out criteria try removing other search criteria
  4. Enter the appropriate search parameters and click Search

Payment Requests

Payment Requests search results show PaymentRequest's created in the POST /v1/paymentRequest call

Here is a description of the columns:

  • Client Transaction ID: An ID you provide in the PaymentRequest to reference transaction data in your own systems
  • PayID: this is the PayID to which your customer can make their payment
  • Client Branch: additional transaction data point that you optionally choose to add to your PaymentRequests, examples might include which branch or channel in your business generated the transaction
  • Created Date Time: this is the date when the PayID was created
  • Status: the status of PaymentRequest. May be one of:
    • WAITING - the PayID is registered but no acceptable payment has been received
    • COMPLETE - an acceptable payment has been received
    • EXPIRED - no acceptable payment was received before the PaymentRequest expired
    • RETURN_IN_PROGRESS - a payment was received but is in the midst of being returned to the source account
    • RETURN_COMPLETE - the payment was returned to the source account
    • RETURN_PENDING_LIQUIDITY - the payment is waiting till the account has sufficient balance to refund
    • RETURN_FAILED - the payment return failed to process
  • Amount: the requested payment amount

Each PaymentRequest can be expanded to show more details:

These details include:

  • Other parameters supplied in the POST /v1/paymentRequest call such as payment description
  • Data received from the payer such as description, reference and where enabled source account information such as payee name, bsb and account number
  • A timeline of events associated with this PaymentRequest
  • The option to refund the payment back to the source account and information on the amount available to be refunded

Outbound Payments

Outbound Payments search results show Payments made using the POST /v1/payment call

Here is a description of the columns:

  • Client Transaction ID: An ID you provide in the Payment API call to reference transaction data in your own systems
  • Account/PayID: this is the PayID or the BSB/Account Number to which the payment was made
  • NPP Transaction ID: A transaction ID automatically applied by NPP as the payment is processed. It is possible the recipient of your funds will quote this reference number as they may see it on their bank statement.
  • Name: The name of the Payee this payment is being sent to
  • Description: Text you provide in the Payment API call
  • Reference: A reference to the payee so that they can easily identify the payer or purpose of the transaction
  • Created Date: this is the date when the payment was made
  • Status: the status of PaymentRequest. May be one of:
    • CREATED - the payment has been requested but is awaiting settlement
    • SETTLED - the payment was settled into the target account
    • FAILED - the payment was rejected
    • PENDING - the payment is pending settlement
    • RETURNED - the payment was initially settled then later returned
  • Amount: the requested payment amount

Payment Initiations

Payment Initiations search results show PaymentInitiation's created in the POST /v1/paymentInitiation call.

Payment Initiations search results include a button to 'Configure Results'. Use this to specify which columns you want to see displayed in the search results. Any columns selected will be included in the Export feature.

Default columns

Here is a description of the default columns:

Column Name Column Description
Payment Initiation ID ID that identifies the payment initiation
Account/PayID Payer's Bank Account or PayID of the payment agreement
Payer Name Payer's name of the payment agreement
Created Date Date when the payment initiation was created
Status Status of payment initiation. May be one of:
  • CREATED - the payment initiation has been created
  • SETTLED - the payment initiation has settled
  • PENDING - the payment initiation is pending
  • FAILED - the payment initiation has failed
  • RETURN_IN_PROGRESS - the payment initiation refund in progress
  • RETURN_FAILED - the payment initiation refund has failed
  • RETURN_COMPLETE - the payment initiation refund completed
Amount Requested payment amount

Additional fields

Additional fields can be configured to be displayed:

Column Name Column Description
Payment Agreement ID ID that identifies the payment agreement
Client Transaction ID ID that identifies the transaction created by the merchant system
NPP Transaction ID ID used to reference a payment pulled from a bank account between banks, businesses and payment facilitators such as Azupay
Completed Date Date when the payment initiation was completed
Reference This is used to unambiguously identify the payment initiation
Description Optional remittance information used to unambiguously refer to the payment initiation

Configure the search results

You can configure additional fields to be displayed by clicking the button and selecting the optional fields within the modal then saving.