JSDoc: Class: Payment

new Payment()

Source:

payments/Payment.js, line 29

Methods

(static) Payment#getAdditionalCharges() → {Array.<payments.AdditionalChargeAmount>}

Get the field value

Source:

payments/Payment.js, line 447

Returns:

An array of

Type: Array.<payments.AdditionalChargeAmount>

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

Get the field value Total amount paid

Source:

payments/Payment.js, line 168

Returns:

must be a long integer

Type: Number

(static) Payment#getAppTracking() → {apps.AppTracking|Null}

Get the field value Tracking information for the app that created this payment.

Source:

payments/Payment.js, line 624

Returns:

Type: apps.AppTracking | Null

(static) Payment#getCardTransaction() → {payments.CardTransaction}

Get the field value Information about the card used for credit/debit card payments

Source:

payments/Payment.js, line 408

Returns:

Type: payments.CardTransaction

(static) Payment#getCashAdvanceExtra() → {payments.CashAdvanceExtra|Null}

Get the field value Information specific to cash advance transactions.

Source:

payments/Payment.js, line 645

Returns:

Type: payments.CashAdvanceExtra | Null

(static) Payment#getCashbackAmount() → {Number|Null}

Get the field value Amount given back in a cash back transaction

Source:

payments/Payment.js, line 231

Returns:

must be a long integer,

Type: Number | Null

(static) Payment#getCashTendered() → {Number|Null}

Get the field value Amount of cash given by the customer

Source:

payments/Payment.js, line 252

Returns:

must be a long integer,

Type: Number | Null

(static) Payment#getClientCreatedTime() → {Number}

Get the field value

Source:

payments/Payment.js, line 330

Returns:

must be a long integer

Type: Number

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

Get the field value Time payment was recorded on server

Source:

payments/Payment.js, line 312

Returns:

must be a long integer

Type: Number

(static) Payment#getDccInfo() → {payments.DCCInfo|Null}

Get the field value Dynamic Currency Conversion information

Source:

payments/Payment.js, line 561

Returns:

Type: payments.DCCInfo | Null

(static) Payment#getDevice() → {base.Reference|Null}

Get the field value Device which processed the transaction for this payment

Source:

payments/Payment.js, line 126

Returns:

Type: base.Reference | Null

(static) Payment#getEmployee() → {base.Reference}

Get the field value The employee who processed the payment

Source:

payments/Payment.js, line 291

Returns:

Type: base.Reference

(static) Payment#getExternalPaymentId() → {String}

Get the field value

Source:

payments/Payment.js, line 270

Returns:

Type: String

(static) Payment#getExternalReferenceId() → {String|Null}

Get the field value The external reference id if associated with the payment

Source:

payments/Payment.js, line 708

Returns:

Type: String | Null

(static) Payment#getGermanInfo() → {payments.GermanInfo|Null}

Get the field value German region-specific information

Source:

payments/Payment.js, line 603

Returns:

Type: payments.GermanInfo | Null

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

Get the field value Unique identifier

Source:

payments/Payment.js, line 84

Returns:

Type: String

(static) Payment#getLineItemPayments() → {Array.<payments.LineItemPayment>}

Get the field value

Source:

payments/Payment.js, line 519

Returns:

An array of

Type: Array.<payments.LineItemPayment>

(static) Payment#getMerchant() → {base.Reference}

Get the field value

Source:

payments/Payment.js, line 726

Returns:

Type: base.Reference

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

Get the field value Last modified time of the payment

Source:

payments/Payment.js, line 351

Returns:

must be a long integer

Type: Number

(static) Payment#getNote() → {String}

Get the field value

Source:

payments/Payment.js, line 501

Returns:

Type: String

(static) Payment#getOffline() → {Boolean}

Get the field value

Source:

payments/Payment.js, line 369

Returns:

Type: Boolean

(static) Payment#getOrder() → {base.Reference}

Get the field value The order with which the payment is associated

Source:

payments/Payment.js, line 105

Returns:

Type: base.Reference

(static) Payment#getRefunds() → {Array.<payments.Refund>}

Get the field value

Source:

payments/Payment.js, line 483

Returns:

An array of

Type: Array.<payments.Refund>

(static) Payment#getResult() → {payments.Result}

Get the field value

Source:

payments/Payment.js, line 387

Returns:

Type: payments.Result

(static) Payment#getServiceCharge() → {payments.ServiceChargeAmount}

Get the field value Amount record as a service charge

Source:

payments/Payment.js, line 429

Returns:

Type: payments.ServiceChargeAmount

(static) Payment#getSignatureDisclaimer() → {payments.SignatureDisclaimer|Null}

Get the field value Information displayed to customer for storing electronic signatures

Source:

payments/Payment.js, line 687

Returns:

Type: payments.SignatureDisclaimer | Null

(static) Payment#getTaxAmount() → {Number|Null}

Get the field value Amount paid in tax

Source:

payments/Payment.js, line 210

Returns:

must be a long integer,

Type: Number | Null

(static) Payment#getTaxRates() → {Array.<payments.PaymentTaxRate>}

Get the field value

Source:

payments/Payment.js, line 465

Returns:

An array of

Type: Array.<payments.PaymentTaxRate>

(static) Payment#getTender() → {base.Tender}

Get the field value The tender type associated with this payment, e.g. credit card, cash, etc.

Source:

payments/Payment.js, line 147

Returns:

Type: base.Tender

(static) Payment#getTipAmount() → {Number|Null}

Get the field value Amount paid in tips

Source:

payments/Payment.js, line 189

Returns:

must be a long integer,

Type: Number | Null

(static) Payment#getTransactionInfo() → {payments.TransactionInfo|Null}

Get the field value Transaction information

Source:

payments/Payment.js, line 666

Returns:

Type: payments.TransactionInfo | Null

(static) Payment#getTransactionSettings() → {payments.TransactionSettings}

Get the field value Per transaction settings for the payment

Source:

payments/Payment.js, line 582

Returns:

Type: payments.TransactionSettings

(static) Payment#getVoidReason() → {order.VoidReason}

Get the field value If voided, the reason why (when available)

Source:

payments/Payment.js, line 540

Returns:

Type: order.VoidReason

(static) Payment#setAdditionalCharges(additionalCharges)

Set the field value

Parameters:

Name	Type	Description
`additionalCharges`	Array.<payments.AdditionalChargeAmount>	An array of

Source:

payments/Payment.js, line 438

(static) Payment#setAmount(amount)

Set the field value Total amount paid

Parameters:

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

Source:

payments/Payment.js, line 158

(static) Payment#setAppTracking(appTracking)

Set the field value Tracking information for the app that created this payment.

Parameters:

Name	Type	Description
`appTracking`	apps.AppTracking \| Null

Source:

payments/Payment.js, line 614

(static) Payment#setCardTransaction(cardTransaction)

Set the field value Information about the card used for credit/debit card payments

Parameters:

Name	Type	Description
`cardTransaction`	payments.CardTransaction

Source:

payments/Payment.js, line 398

(static) Payment#setCashAdvanceExtra(cashAdvanceExtra)

Set the field value Information specific to cash advance transactions.

Parameters:

Name	Type	Description
`cashAdvanceExtra`	payments.CashAdvanceExtra \| Null

Source:

payments/Payment.js, line 635

(static) Payment#setCashbackAmount(cashbackAmount)

Set the field value Amount given back in a cash back transaction

Parameters:

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

Source:

payments/Payment.js, line 221

(static) Payment#setCashTendered(cashTendered)

Set the field value Amount of cash given by the customer

Parameters:

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

Source:

payments/Payment.js, line 242

(static) Payment#setClientCreatedTime(clientCreatedTime)

Set the field value

Parameters:

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

Source:

payments/Payment.js, line 321

(static) Payment#setCreatedTime(createdTime)

Set the field value Time payment was recorded on server

Parameters:

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

Source:

payments/Payment.js, line 302

(static) Payment#setDccInfo(dccInfo)

Set the field value Dynamic Currency Conversion information

Parameters:

Name	Type	Description
`dccInfo`	payments.DCCInfo \| Null

Source:

payments/Payment.js, line 551

(static) Payment#setDevice(device)

Set the field value Device which processed the transaction for this payment

Parameters:

Name	Type	Description
`device`	base.Reference \| Null

Source:

payments/Payment.js, line 116

(static) Payment#setEmployee(employee)

Set the field value The employee who processed the payment

Parameters:

Name	Type	Description
`employee`	base.Reference

Source:

payments/Payment.js, line 281

(static) Payment#setExternalPaymentId(externalPaymentId)

Set the field value

Parameters:

Name	Type	Description
`externalPaymentId`	String

Source:

payments/Payment.js, line 261

(static) Payment#setExternalReferenceId(externalReferenceId)

Set the field value The external reference id if associated with the payment

Parameters:

Name	Type	Description
`externalReferenceId`	String \| Null

Source:

payments/Payment.js, line 698

(static) Payment#setGermanInfo(germanInfo)

Set the field value German region-specific information

Parameters:

Name	Type	Description
`germanInfo`	payments.GermanInfo \| Null

Source:

payments/Payment.js, line 593

(static) Payment#setId(id)

Set the field value Unique identifier

Parameters:

Name	Type	Description
`id`	String

Source:

payments/Payment.js, line 74

(static) Payment#setLineItemPayments(lineItemPayments)

Set the field value

Parameters:

Name	Type	Description
`lineItemPayments`	Array.<payments.LineItemPayment>	An array of

Source:

payments/Payment.js, line 510

(static) Payment#setMerchant(merchant)

Set the field value

Parameters:

Name	Type	Description
`merchant`	base.Reference

Source:

payments/Payment.js, line 717

(static) Payment#setModifiedTime(modifiedTime)

Set the field value Last modified time of the payment

Parameters:

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

Source:

payments/Payment.js, line 341

(static) Payment#setNote(note)

Set the field value

Parameters:

Name	Type	Description
`note`	String

Source:

payments/Payment.js, line 492

(static) Payment#setOffline(offline)

Set the field value

Parameters:

Name	Type	Description
`offline`	Boolean

Source:

payments/Payment.js, line 360

(static) Payment#setOrder(order)

Set the field value The order with which the payment is associated

Parameters:

Name	Type	Description
`order`	base.Reference

Source:

payments/Payment.js, line 95

(static) Payment#setRefunds(refunds)

Set the field value

Parameters:

Name	Type	Description
`refunds`	Array.<payments.Refund>	An array of

Source:

payments/Payment.js, line 474

(static) Payment#setResult(result)

Set the field value

Parameters:

Name	Type	Description
`result`	payments.Result

Source:

payments/Payment.js, line 378

(static) Payment#setServiceCharge(serviceCharge)

Set the field value Amount record as a service charge

Parameters:

Name	Type	Description
`serviceCharge`	payments.ServiceChargeAmount

Source:

payments/Payment.js, line 419

(static) Payment#setSignatureDisclaimer(signatureDisclaimer)

Set the field value Information displayed to customer for storing electronic signatures

Parameters:

Name	Type	Description
`signatureDisclaimer`	payments.SignatureDisclaimer \| Null

Source:

payments/Payment.js, line 677

(static) Payment#setTaxAmount(taxAmount)

Set the field value Amount paid in tax

Parameters:

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

Source:

payments/Payment.js, line 200

(static) Payment#setTaxRates(taxRates)

Set the field value

Parameters:

Name	Type	Description
`taxRates`	Array.<payments.PaymentTaxRate>	An array of

Source:

payments/Payment.js, line 456

(static) Payment#setTender(tender)

Set the field value The tender type associated with this payment, e.g. credit card, cash, etc.

Parameters:

Name	Type	Description
`tender`	base.Tender

Source:

payments/Payment.js, line 137

(static) Payment#setTipAmount(tipAmount)

Set the field value Amount paid in tips

Parameters:

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

Source:

payments/Payment.js, line 179

(static) Payment#setTransactionInfo(transactionInfo)

Set the field value Transaction information

Parameters:

Name	Type	Description
`transactionInfo`	payments.TransactionInfo \| Null

Source:

payments/Payment.js, line 656

(static) Payment#setTransactionSettings(transactionSettings)

Set the field value Per transaction settings for the payment

Parameters:

Name	Type	Description
`transactionSettings`	payments.TransactionSettings

Source:

payments/Payment.js, line 572

(static) Payment#setVoidReason(voidReason)

Set the field value If voided, the reason why (when available)

Parameters:

Name	Type	Description
`voidReason`	order.VoidReason

Source:

payments/Payment.js, line 530