Class: Credit

payments.Credit()

new Credit()

Source:

Methods

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

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

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

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

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

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

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

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

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

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

(static) Credit#getCreditRefunds() → {Array.<payments.CreditRefund>}

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

(static) Credit#getCustomers() → {customers.Customer}

Get the field value Customer who received the credit/refund
Source:
Returns:
Type
customers.Customer

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(static) Credit#getTaxRates() → {Array.<payments.TaxableAmountRate>}

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

(static) Credit#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) Credit#getTransactionInfo() → {payments.TransactionInfo|Null}

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

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

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

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

Get the field value
Source:
Returns:
Type
Boolean

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

Get the field value
Source:
Returns:
Type
String

(static) Credit#setAmount(amount)

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

(static) Credit#setAppTracking(appTracking)

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

(static) Credit#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) Credit#setClientCreatedTime(clientCreatedTime)

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

(static) Credit#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) Credit#setCreditRefunds(creditRefunds)

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

(static) Credit#setCustomers(customers)

Set the field value Customer who received the credit/refund
Parameters:
Name Type Description
customers customers.Customer
Source:

(static) Credit#setDccInfo(dccInfo)

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

(static) Credit#setDevice(device)

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

(static) Credit#setEmployee(employee)

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

(static) Credit#setGermanInfo(germanInfo)

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

(static) Credit#setId(id)

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

(static) Credit#setMerchant(merchant)

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

(static) Credit#setOrderRef(orderRef)

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

(static) Credit#setResult(result)

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

(static) Credit#setTaxAmount(taxAmount)

Set the field value Amount paid in tax
Parameters:
Name Type Description
taxAmount Number | Null must be a long integer,
Source:

(static) Credit#setTaxRates(taxRates)

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

(static) Credit#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) Credit#setTransactionInfo(transactionInfo)

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

(static) Credit#setTransactionSettings(transactionSettings)

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

(static) Credit#setVoided(voided)

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

(static) Credit#setVoidReason(voidReason)

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