CC Westpac Batch UML

Parent: File Batch

Added On: 07/20/15

SQL Table: CC_WESTPAC_BATCH

Module: UniCharge

Type: Entity Status: Active

Java Class: CcWestpacBatch

Represents a batch of transactions as it is defined in Westpac's batch processing specification.

Available Fields:

Batch Description
Batch Transaction Amount
Batch Transaction Count
Batch Type
Client Name

Community Code
Company Code
Company Name
Currency
File Creation Date

File Creation Time
Merchant Account Code
Refund Flag
Unique Batch Identifier
Unique File Identifier

Batch Description

Added On: 07/20/15

SQL Column: BATCH_DESCRIPTION

Java Field: batchDescription

Status: Active

SQL Type: varchar(18)

Java Type: String

Attributes:

Optional human readable batch description.

Batch Transaction Amount

Added On: 07/20/15

SQL Column: BATCH_TRANSACTION_AMOUNT

Java Field: batchTransactionAmount

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

The total amount of all the transactions in the batch (in cents).

Batch Transaction Count

Added On: 07/20/15

SQL Column: BATCH_TRANSACTION_COUNT

Java Field: batchTransactionCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

The total number of transaction detail records (“5” Records) in the batch.

Batch Type

Added On: 07/20/15

SQL Column: BATCH_TYPE

Java Field: batchType

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Indicates the type of transactions contained within this batch.

CC – credit card transactions
DD – direct debit transactions against bank accounts.

Client Name

Added On: 07/20/15

SQL Column: CLIENT_NAME

Java Field: clientName

Status: Active

SQL Type: varchar(30)

Java Type: String

Attributes:

Name of the client.

Community Code

Added On: 07/20/15

SQL Column: COMMUNITY_CODE

Java Field: communityCode

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

The community code provided by Westpac.
Uniquely identifies the organisation within Quickstream.

Company Code

Added On: 07/20/15

SQL Column: COMPANY_CODE

Java Field: companyCode

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

The company code provided by Westpac.
Used to determine which account to process the transactions against.

Note: If required Westpac can provide with multiple company identifiers, this will allow to deposit funds into different accounts.

Company Name

Added On: 07/20/15

SQL Column: COMPANY_NAME

Java Field: companyName

Status: Active

SQL Type: varchar(30)

Java Type: String

Attributes:

A human readable company name.

Currency

Added On: 07/20/15

SQL Column: CURRENCY

Java Field: currency

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Currency code of the transactions within the batch.

File Creation Date

Added On: 07/20/15

SQL Column: FILE_CREATION_DATE

Java Field: fileCreationDate

Status: Active

SQL Type: varchar(8)

Java Type: String

Attributes:

Date when the file was created.

File Creation Time

Added On: 07/20/15

SQL Column: FILE_CREATION_TIME

Java Field: fileCreationTime

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Time when the file was created.

Merchant Account Code

Added On: 07/20/15

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required

Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

Refund Flag

Added On: 07/20/15

SQL Column: REFUND_FLAG

Java Field: refundFlag

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

A flag that allows to mark the batch as a refund batch.

Set to uppercase “R” to mark all transactions in this batch as refunds. These transactions will be processed as credits to customers’ accounts.
Leave blank to indicate all transactions in the batch are payments. These transactions will be processed as debits against your customers’ accounts.

Unique Batch Identifier

Added On: 07/20/15

SQL Column: UNIQUE_BATCH_IDENTIFIER

Java Field: uniqueBatchIdentifier

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

A unique identifier for the given batch.

Note: Qvalent recommends this value to be formatted as the Unique File Identifier suffixed by the current batch number. E.g. YYYYMMDD##_NN.
Quickstream will only process a batch with a unique identifier once. Any subsequent batches with the same identifier will be rejected.

Unique File Identifier

Added On: 07/20/15

SQL Column: UNIQUE_FILE_IDENTIFIER

Java Field: uniqueFileIdentifier

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

A unique identifier for the file.
QuickBatch will only process a file with a unique identifier once. Any subsequent files with the same identifier will be rejected.

Note: It is recommended to include the created date suffixed by a file sequence number to ensure the value is unique. For example, YYYYMMDD##.

All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.