Class: Batch

payments.Batch()

new Batch()

Source:

Methods

(static) Batch#getBatchDetails() → {payments.BatchDetail}

Get the field value Details split based on card / employees
Source:
Returns:
Type
payments.BatchDetail

(static) Batch#getBatchTransactions() → {payments.BatchTransactions}

Get the field value List of payments, refunds, and gift card transaction reference objects in the batch
Source:
Returns:
Type
payments.BatchTransactions

(static) Batch#getBatchType() → {payments.BatchType}

Get the field value
Source:
Returns:
Type
payments.BatchType

(static) Batch#getCloseoutTimeDifference() → {Number}

Get the field value Time difference in minutes between expected and actual closeout
Source:
Returns:
must be a long integer
Type
Number

(static) Batch#getCreatedTime() → {Number}

Get the field value Created time of batch
Source:
Returns:
must be a long integer
Type
Number

(static) Batch#getDevices() → {String}

Get the field value List of devices in batch
Source:
Returns:
Type
String

(static) Batch#getId() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Batch#getModifiedTime() → {Number}

Get the field value Modified time of batch
Source:
Returns:
must be a long integer
Type
Number

(static) Batch#getState() → {payments.BatchState}

Get the field value
Source:
Returns:
Type
payments.BatchState

(static) Batch#getTotalBatchAmount() → {Number}

Get the field value Total amount closed
Source:
Returns:
must be a long integer
Type
Number

(static) Batch#getTxCount() → {Number}

Get the field value The number of transactions being batched
Source:
Returns:
must be a long integer
Type
Number

(static) Batch#setBatchDetails(batchDetails)

Set the field value Details split based on card / employees
Parameters:
Name Type Description
batchDetails payments.BatchDetail
Source:

(static) Batch#setBatchTransactions(batchTransactions)

Set the field value List of payments, refunds, and gift card transaction reference objects in the batch
Parameters:
Name Type Description
batchTransactions payments.BatchTransactions
Source:

(static) Batch#setBatchType(batchType)

Set the field value
Parameters:
Name Type Description
batchType payments.BatchType
Source:

(static) Batch#setCloseoutTimeDifference(closeoutTimeDifference)

Set the field value Time difference in minutes between expected and actual closeout
Parameters:
Name Type Description
closeoutTimeDifference Number must be a long integer
Source:

(static) Batch#setCreatedTime(createdTime)

Set the field value Created time of batch
Parameters:
Name Type Description
createdTime Number must be a long integer
Source:

(static) Batch#setDevices(devices)

Set the field value List of devices in batch
Parameters:
Name Type Description
devices String
Source:

(static) Batch#setId(id)

Set the field value
Parameters:
Name Type Description
id String
Source:

(static) Batch#setModifiedTime(modifiedTime)

Set the field value Modified time of batch
Parameters:
Name Type Description
modifiedTime Number must be a long integer
Source:

(static) Batch#setState(state)

Set the field value
Parameters:
Name Type Description
state payments.BatchState
Source:

(static) Batch#setTotalBatchAmount(totalBatchAmount)

Set the field value Total amount closed
Parameters:
Name Type Description
totalBatchAmount Number must be a long integer
Source:

(static) Batch#setTxCount(txCount)

Set the field value The number of transactions being batched
Parameters:
Name Type Description
txCount Number must be a long integer
Source: