Home Nodes Netcash Inbound Payments Batch Status

Netcash Inbound Payments Batch Status

Netcash Inbound Payments Batch Status lets you pull the latest status of your debit order batches - by count, date range, or exact batch name.

Revision History

1.0.0.0 Initial release

Properties

Connection

Type: Connection Input
The Netcash Connection you want to use for the inbound batch status. For this Node, you only need to provide the AccountNumber, AccountServiceKey, and DebitOrderServiceKey in the Connection properties.

AccountNumber
Type: String Input
Your Netcash Account number - number starts with "5" and is N11.

AccountServiceKey
Type: String Input
Your Netcash Account Service Key. Access on Netcash by navigating to "Account Profile → NetConnector → Account Service".

DebitOrderServiceKey
Type: String Input
Your Netcash Debit Order Service Key. Access on Netcash by navigating to "Account Profile → NetConnector → Debit Orders".

Action

Type: List Input
Action that represents the currently chosen sample.

  • Retrieve
  • RetrieveByDate
  • RetrieveByName

Response

Type: JSON Output
Contains the data returned from Netcash after a successful operation. The response is formatted as JSON output.

Using the Node

1. Create the Connection

  1. In the Flowgear Console, click Connections.
  2. Add a new Connection of type Netcash Inbound Payments Batch Status.
  3. Enter the AccountNumber, AccountServiceKey, and DebiOrderServiceKey from your Netcash Account.
  4. Save your Connection.

2. Test your Connection

  1. Navigate to your new Netcash Connection.
  2. Click Test.
  3. Flowgear will attempt a test API call to a generic Netcash endpoint to ensure your credentials are valid.

If the test is successful (✓), your credentials are valid.
If it fails (✗), the test will return an error message, and you may need to re-authorise the Connection. If this problem persists, please contact support for assistance.

3. Select a Sample

Select a sample to automatically set up the Node for your desired operation.

Choose from the following:

  • Retrieve Debit Order Batch Statuses by Number
    • NumberOfBatches: Optional, defaults to 10. Max 100.
  • Retrieve Debit Order Batch Statuses by Date
    • StartDate, EndDate: CCYYMMDD format, and must span less than or equal to 90 days.
  • Retrieve Debit Order Batch Statuses by Name
    • BatchName: Must match exactly.