Class: Payment

payments.Payment()

new Payment()

Source:

Methods

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

Get the field value
Source:
Returns:
An array of
Type
Array.<payments.AdditionalChargeAmount>

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

Get the field value Total amount paid
Source:
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:
Returns:
Type
apps.AppTracking | Null

(static) Payment#getAttributes() → {Object.<String, String>}

Get the field value
Source:
Returns:
A map of to <>
Type
Object.<String, String>

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

Get the field value Authorization which this payment is associated to (opening or closing payment) if one exists
Source:
Returns:
Type
base.Reference

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

Get the field value Information about the card used for credit/debit card payments
Source:
Returns:
Type
payments.CardTransaction

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

Get the field value Information specific to cash advance transactions.
Source:
Returns:
Type
payments.CashAdvanceExtra | Null

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

Get the field value Amount given back in a cash back transaction
Source:
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:
Returns:
must be a long integer,
Type
Number | Null

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

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

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

Get the field value Time payment was recorded on server
Source:
Returns:
must be a long integer
Type
Number

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

Get the field value Dynamic Currency Conversion information
Source:
Returns:
Type
payments.DCCInfo | Null

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

Get the field value Device which processed the transaction for this payment, a 128-bit UUID, not a normal base-13 Clover ID.
Source:
Returns:
Type
base.Reference | Null

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

Get the field value The employee who processed the payment
Source:
Returns:
Type
base.Reference

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

Get the field value
Source:
Returns:
Type
String

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

Get the field value The external reference id if associated with the payment
Source:
Returns:
Type
String | Null

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

Get the field value German region-specific information
Source:
Returns:
Type
payments.GermanInfo | Null

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

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) Payment#getIncrements() → {Array.<payments.IncrementalAuthorization>}

Get the field value
Source:
Returns:
An array of
Type
Array.<payments.IncrementalAuthorization>

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

Get the field value
Source:
Returns:
An array of
Type
Array.<payments.LineItemPayment>

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

Get the field value
Source:
Returns:
Type
base.Reference

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

Get the field value Last modified time of the payment
Source:
Returns:
must be a long integer
Type
Number

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

Get the field value
Source:
Returns:
Type
String

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

Get the field value
Source:
Returns:
Type
Boolean

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

Get the field value The order with which the payment is associated
Source:
Returns:
Type
base.Reference

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

Get the field value
Source:
Returns:
An array of
Type
Array.<payments.Refund>

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

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

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

Get the field value Amount record as a service charge
Source:
Returns:
Type
payments.ServiceChargeAmount

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

Get the field value Information displayed to customer for storing electronic signatures
Source:
Returns:
Type
payments.SignatureDisclaimer | Null

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

Get the field value Amount paid in tax
Source:
Returns:
must be a long integer,
Type
Number | Null

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

Get the field value
Source:
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:
Returns:
Type
base.Tender

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

Get the field value Amount paid in tips
Source:
Returns:
must be a long integer,
Type
Number | Null

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

Get the field value Transaction information
Source:
Returns:
Type
payments.TransactionInfo | Null

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

Get the field value Per transaction settings for the payment
Source:
Returns:
Type
payments.TransactionSettings

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

Get the field value If voided, the corresponding successful payment, and vice versa
Source:
Returns:
Type
base.Reference

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

Get the field value If voided, the reason why (when available)
Source:
Returns:
Type
order.VoidReason

(static) Payment#setAdditionalCharges(additionalCharges)

Set the field value
Parameters:
Name Type Description
additionalCharges Array.<payments.AdditionalChargeAmount> An array of
Source:

(static) Payment#setAmount(amount)

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

(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:

(static) Payment#setAttributes(attributes)

Set the field value
Parameters:
Name Type Description
attributes Object.<String, String> A map of to <>
Source:

(static) Payment#setAuthorization(authorization)

Set the field value Authorization which this payment is associated to (opening or closing payment) if one exists
Parameters:
Name Type Description
authorization base.Reference
Source:

(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:

(static) Payment#setCashAdvanceExtra(cashAdvanceExtra)

Set the field value Information specific to cash advance transactions.
Parameters:
Name Type Description
cashAdvanceExtra payments.CashAdvanceExtra | Null
Source:

(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:

(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:

(static) Payment#setClientCreatedTime(clientCreatedTime)

Set the field value
Parameters:
Name Type Description
clientCreatedTime Number must be a long integer
Source:

(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:

(static) Payment#setDccInfo(dccInfo)

Set the field value Dynamic Currency Conversion information
Parameters:
Name Type Description
dccInfo payments.DCCInfo | Null
Source:

(static) Payment#setDevice(device)

Set the field value Device which processed the transaction for this payment, a 128-bit UUID, not a normal base-13 Clover ID.
Parameters:
Name Type Description
device base.Reference | Null
Source:

(static) Payment#setEmployee(employee)

Set the field value The employee who processed the payment
Parameters:
Name Type Description
employee base.Reference
Source:

(static) Payment#setExternalPaymentId(externalPaymentId)

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

(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:

(static) Payment#setGermanInfo(germanInfo)

Set the field value German region-specific information
Parameters:
Name Type Description
germanInfo payments.GermanInfo | Null
Source:

(static) Payment#setId(id)

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

(static) Payment#setIncrements(increments)

Set the field value
Parameters:
Name Type Description
increments Array.<payments.IncrementalAuthorization> An array of
Source:

(static) Payment#setLineItemPayments(lineItemPayments)

Set the field value
Parameters:
Name Type Description
lineItemPayments Array.<payments.LineItemPayment> An array of
Source:

(static) Payment#setMerchant(merchant)

Set the field value
Parameters:
Name Type Description
merchant base.Reference
Source:

(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:

(static) Payment#setNote(note)

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

(static) Payment#setOffline(offline)

Set the field value
Parameters:
Name Type Description
offline Boolean
Source:

(static) Payment#setOrder(order)

Set the field value The order with which the payment is associated
Parameters:
Name Type Description
order base.Reference
Source:

(static) Payment#setRefunds(refunds)

Set the field value
Parameters:
Name Type Description
refunds Array.<payments.Refund> An array of
Source:

(static) Payment#setResult(result)

Set the field value
Parameters:
Name Type Description
result payments.Result
Source:

(static) Payment#setServiceCharge(serviceCharge)

Set the field value Amount record as a service charge
Parameters:
Name Type Description
serviceCharge payments.ServiceChargeAmount
Source:

(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:

(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:

(static) Payment#setTaxRates(taxRates)

Set the field value
Parameters:
Name Type Description
taxRates Array.<payments.PaymentTaxRate> An array of
Source:

(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:

(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:

(static) Payment#setTransactionInfo(transactionInfo)

Set the field value Transaction information
Parameters:
Name Type Description
transactionInfo payments.TransactionInfo | Null
Source:

(static) Payment#setTransactionSettings(transactionSettings)

Set the field value Per transaction settings for the payment
Parameters:
Name Type Description
transactionSettings payments.TransactionSettings
Source:

(static) Payment#setVoidPaymentRef(voidPaymentRef)

Set the field value If voided, the corresponding successful payment, and vice versa
Parameters:
Name Type Description
voidPaymentRef base.Reference
Source:

(static) Payment#setVoidReason(voidReason)

Set the field value If voided, the reason why (when available)
Parameters:
Name Type Description
voidReason order.VoidReason
Source: