JSDoc: Class: GatewayTxs

new GatewayTxs()

Source:

payments/GatewayTxs.js, line 17

Methods

(static) GatewayTxs#getAdjustAmount() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 121

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getAmount() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 103

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getAuthcode() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 391

Returns:

Type: String

(static) GatewayTxs#getCaptured() → {Boolean|Null}

Get the field value

Source:

payments/GatewayTxs.js, line 445

Returns:

Type: Boolean | Null

(static) GatewayTxs#getCardType() → {payments.CardType}

Get the field value

Source:

payments/GatewayTxs.js, line 337

Returns:

Type: payments.CardType

(static) GatewayTxs#getClientId() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 85

Returns:

Type: String

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

Get the field value

Source:

payments/GatewayTxs.js, line 499

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getCurrency() → {payments.Currency}

Get the field value

Source:

payments/GatewayTxs.js, line 175

Returns:

Type: payments.Currency

(static) GatewayTxs#getEmployeeId() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 409

Returns:

Type: String

(static) GatewayTxs#getEntryType() → {payments.CardEntryType}

Get the field value

Source:

payments/GatewayTxs.js, line 247

Returns:

Type: payments.CardEntryType

(static) GatewayTxs#getExtra() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 427

Returns:

Type: String

(static) GatewayTxs#getExtraGatewayInfo() → {Object.<String, String>}

Get the field value

Source:

payments/GatewayTxs.js, line 571

Returns:

A map of to <>

Type: Object.<String, String>

(static) GatewayTxs#getFirst4() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 301

Returns:

Type: String

(static) GatewayTxs#getKsnPrefix() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 481

Returns:

Type: String

(static) GatewayTxs#getLast4() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 319

Returns:

Type: String

(static) GatewayTxs#getMerchantGatewayId() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 67

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

payments/GatewayTxs.js, line 517

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getPaymentDeviceId() → {Number|Null}

Get the field value

Source:

payments/GatewayTxs.js, line 607

Returns:

must be a long integer,

Type: Number | Null

(static) GatewayTxs#getPaymentRefundId() → {Number|Null}

Get the field value

Source:

payments/GatewayTxs.js, line 553

Returns:

must be a long integer,

Type: Number | Null

(static) GatewayTxs#getRefnum() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 355

Returns:

Type: String

(static) GatewayTxs#getRefundDeviceId() → {Number|Null}

Get the field value

Source:

payments/GatewayTxs.js, line 589

Returns:

must be a long integer,

Type: Number | Null

(static) GatewayTxs#getRefundId() → {Number|Null}

Get the field value

Source:

payments/GatewayTxs.js, line 535

Returns:

must be a long integer,

Type: Number | Null

(static) GatewayTxs#getResponseCode() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 265

Returns:

Type: String

(static) GatewayTxs#getResponseMessage() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 283

Returns:

Type: String

(static) GatewayTxs#getRetries() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 211

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getState() → {payments.GatewayTxState}

Get the field value

Source:

payments/GatewayTxs.js, line 193

Returns:

Type: payments.GatewayTxState

(static) GatewayTxs#getSwiperSerial() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 463

Returns:

Type: String

(static) GatewayTxs#getTaxAmount() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 139

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getTipAmount() → {Number}

Get the field value

Source:

payments/GatewayTxs.js, line 157

Returns:

must be a long integer

Type: Number

(static) GatewayTxs#getToken() → {String}

Get the field value

Source:

payments/GatewayTxs.js, line 373

Returns:

Type: String

(static) GatewayTxs#getType() → {payments.GatewayTxType}

Get the field value

Source:

payments/GatewayTxs.js, line 229

Returns:

Type: payments.GatewayTxType

(static) GatewayTxs#setAdjustAmount(adjustAmount)

Set the field value

Parameters:

Name	Type	Description
`adjustAmount`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 112

(static) GatewayTxs#setAmount(amount)

Set the field value

Parameters:

Name	Type	Description
`amount`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 94

(static) GatewayTxs#setAuthcode(authcode)

Set the field value

Parameters:

Name	Type	Description
`authcode`	String

Source:

payments/GatewayTxs.js, line 382

(static) GatewayTxs#setCaptured(captured)

Set the field value

Parameters:

Name	Type	Description
`captured`	Boolean \| Null

Source:

payments/GatewayTxs.js, line 436

(static) GatewayTxs#setCardType(cardType)

Set the field value

Parameters:

Name	Type	Description
`cardType`	payments.CardType

Source:

payments/GatewayTxs.js, line 328

(static) GatewayTxs#setClientId(clientId)

Set the field value

Parameters:

Name	Type	Description
`clientId`	String

Source:

payments/GatewayTxs.js, line 76

(static) GatewayTxs#setCreatedTime(createdTime)

Set the field value

Parameters:

Name	Type	Description
`createdTime`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 490

(static) GatewayTxs#setCurrency(currency)

Set the field value

Parameters:

Name	Type	Description
`currency`	payments.Currency

Source:

payments/GatewayTxs.js, line 166

(static) GatewayTxs#setEmployeeId(employeeId)

Set the field value

Parameters:

Name	Type	Description
`employeeId`	String

Source:

payments/GatewayTxs.js, line 400

(static) GatewayTxs#setEntryType(entryType)

Set the field value

Parameters:

Name	Type	Description
`entryType`	payments.CardEntryType

Source:

payments/GatewayTxs.js, line 238

(static) GatewayTxs#setExtra(extra)

Set the field value

Parameters:

Name	Type	Description
`extra`	String

Source:

payments/GatewayTxs.js, line 418

(static) GatewayTxs#setExtraGatewayInfo(extraGatewayInfo)

Set the field value

Parameters:

Name	Type	Description
`extraGatewayInfo`	Object.<String, String>	A map of to <>

Source:

payments/GatewayTxs.js, line 562

(static) GatewayTxs#setFirst4(first4)

Set the field value

Parameters:

Name	Type	Description
`first4`	String

Source:

payments/GatewayTxs.js, line 292

(static) GatewayTxs#setKsnPrefix(ksnPrefix)

Set the field value

Parameters:

Name	Type	Description
`ksnPrefix`	String

Source:

payments/GatewayTxs.js, line 472

(static) GatewayTxs#setLast4(last4)

Set the field value

Parameters:

Name	Type	Description
`last4`	String

Source:

payments/GatewayTxs.js, line 310

(static) GatewayTxs#setMerchantGatewayId(merchantGatewayId)

Set the field value

Parameters:

Name	Type	Description
`merchantGatewayId`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 58

(static) GatewayTxs#setModifiedTime(modifiedTime)

Set the field value

Parameters:

Name	Type	Description
`modifiedTime`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 508

(static) GatewayTxs#setPaymentDeviceId(paymentDeviceId)

Set the field value

Parameters:

Name	Type	Description
`paymentDeviceId`	Number \| Null	must be a long integer,

Source:

payments/GatewayTxs.js, line 598

(static) GatewayTxs#setPaymentRefundId(paymentRefundId)

Set the field value

Parameters:

Name	Type	Description
`paymentRefundId`	Number \| Null	must be a long integer,

Source:

payments/GatewayTxs.js, line 544

(static) GatewayTxs#setRefnum(refnum)

Set the field value

Parameters:

Name	Type	Description
`refnum`	String

Source:

payments/GatewayTxs.js, line 346

(static) GatewayTxs#setRefundDeviceId(refundDeviceId)

Set the field value

Parameters:

Name	Type	Description
`refundDeviceId`	Number \| Null	must be a long integer,

Source:

payments/GatewayTxs.js, line 580

(static) GatewayTxs#setRefundId(refundId)

Set the field value

Parameters:

Name	Type	Description
`refundId`	Number \| Null	must be a long integer,

Source:

payments/GatewayTxs.js, line 526

(static) GatewayTxs#setResponseCode(responseCode)

Set the field value

Parameters:

Name	Type	Description
`responseCode`	String

Source:

payments/GatewayTxs.js, line 256

(static) GatewayTxs#setResponseMessage(responseMessage)

Set the field value

Parameters:

Name	Type	Description
`responseMessage`	String

Source:

payments/GatewayTxs.js, line 274

(static) GatewayTxs#setRetries(retries)

Set the field value

Parameters:

Name	Type	Description
`retries`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 202

(static) GatewayTxs#setState(state)

Set the field value

Parameters:

Name	Type	Description
`state`	payments.GatewayTxState

Source:

payments/GatewayTxs.js, line 184

(static) GatewayTxs#setSwiperSerial(swiperSerial)

Set the field value

Parameters:

Name	Type	Description
`swiperSerial`	String

Source:

payments/GatewayTxs.js, line 454

(static) GatewayTxs#setTaxAmount(taxAmount)

Set the field value

Parameters:

Name	Type	Description
`taxAmount`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 130

(static) GatewayTxs#setTipAmount(tipAmount)

Set the field value

Parameters:

Name	Type	Description
`tipAmount`	Number	must be a long integer

Source:

payments/GatewayTxs.js, line 148

(static) GatewayTxs#setToken(token)

Set the field value

Parameters:

Name	Type	Description
`token`	String

Source:

payments/GatewayTxs.js, line 364

(static) GatewayTxs#setType(type)

Set the field value

Parameters:

Name	Type	Description
`type`	payments.GatewayTxType

Source:

payments/GatewayTxs.js, line 220