Class: Refund

payments.Refund()

new Refund()

Source:

Methods

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

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

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

Get the field value Total amount refunded, including tax and tip
Source:
Returns:
must be a long integer
Type
Number

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

Get the field value Tracking information for the app that created this refund.
Source:
Returns:
Type
apps.AppTracking | Null

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

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

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

Get the field value The time when the refund was recorded on the client
Source:
Returns:
must be a long integer
Type
Number

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

Get the field value The time when the refund was recorded on the server
Source:
Returns:
must be a long integer
Type
Number

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

Get the field value Device which processed the transaction for this refund
Source:
Returns:
Type
base.Reference | Null

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

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

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

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

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

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

(static) Refund#getLineItems() → {Array.<base.Reference>}

Get the field value
Source:
Returns:
An array of
Type
Array.<base.Reference>

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

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

(static) Refund#getOrderRef() → {base.Reference}

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

(static) Refund#getOverrideMerchantTender() → {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) Refund#getPayment() → {base.Reference}

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

(static) Refund#getServiceChargeAmount() → {payments.ServiceChargeAmount}

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

(static) Refund#getTaxableAmountRates() → {Array.<payments.TaxableAmountRate>}

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

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

Get the field value Tax amount refunded
Source:
Returns:
must be a long integer,
Type
Number | Null

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

Get the field value Tip amount refunded
Source:
Returns:
must be a long integer,
Type
Number | Null

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

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

(static) Refund#getVoided() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) Refund#getVoidReason() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Refund#setAdditionalCharges(additionalCharges)

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

(static) Refund#setAmount(amount)

Set the field value Total amount refunded, including tax and tip
Parameters:
Name Type Description
amount Number must be a long integer
Source:

(static) Refund#setAppTracking(appTracking)

Set the field value Tracking information for the app that created this refund.
Parameters:
Name Type Description
appTracking apps.AppTracking | Null
Source:

(static) Refund#setCardTransaction(cardTransaction)

Set the field value Information about the card used for credit or debit card refunds
Parameters:
Name Type Description
cardTransaction payments.CardTransaction
Source:

(static) Refund#setClientCreatedTime(clientCreatedTime)

Set the field value The time when the refund was recorded on the client
Parameters:
Name Type Description
clientCreatedTime Number must be a long integer
Source:

(static) Refund#setCreatedTime(createdTime)

Set the field value The time when the refund was recorded on the server
Parameters:
Name Type Description
createdTime Number must be a long integer
Source:

(static) Refund#setDevice(device)

Set the field value Device which processed the transaction for this refund
Parameters:
Name Type Description
device base.Reference | Null
Source:

(static) Refund#setEmployee(employee)

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

(static) Refund#setGermanInfo(germanInfo)

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

(static) Refund#setId(id)

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

(static) Refund#setLineItems(lineItems)

Set the field value
Parameters:
Name Type Description
lineItems Array.<base.Reference> An array of
Source:

(static) Refund#setMerchant(merchant)

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

(static) Refund#setOrderRef(orderRef)

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

(static) Refund#setOverrideMerchantTender(overrideMerchantTender)

Set the field value The tender type associated with this payment, e.g. credit card, cash, etc.
Parameters:
Name Type Description
overrideMerchantTender base.Tender
Source:

(static) Refund#setPayment(payment)

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

(static) Refund#setServiceChargeAmount(serviceChargeAmount)

Set the field value
Parameters:
Name Type Description
serviceChargeAmount payments.ServiceChargeAmount
Source:

(static) Refund#setTaxableAmountRates(taxableAmountRates)

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

(static) Refund#setTaxAmount(taxAmount)

Set the field value Tax amount refunded
Parameters:
Name Type Description
taxAmount Number | Null must be a long integer,
Source:

(static) Refund#setTipAmount(tipAmount)

Set the field value Tip amount refunded
Parameters:
Name Type Description
tipAmount Number | Null must be a long integer,
Source:

(static) Refund#setTransactionInfo(transactionInfo)

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

(static) Refund#setVoided(voided)

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

(static) Refund#setVoidReason(voidReason)

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