Class: CardTransaction

payments.CardTransaction()

new CardTransaction()

Source:

Methods

(static) CardTransaction#getAuthCode() → {String}

Get the field value Authorization code (if successful)
Source:
Returns:
Type
String

(static) CardTransaction#getAvsResult() → {payments.AVSResult}

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

(static) CardTransaction#getBegBalance() → {Number|Null}

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

(static) CardTransaction#getCardholderName() → {String}

Get the field value
Source:
Returns:
Type
String

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

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

(static) CardTransaction#getCreditRef() → {Null|base.Reference}

Get the field value The credit with which the card transaction is associated
Source:
Returns:
Type
Null | base.Reference

(static) CardTransaction#getCurrency() → {String}

Get the field value Currency code
Source:
Returns:
Type
String

(static) CardTransaction#getEndBalance() → {Number|Null}

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

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

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

(static) CardTransaction#getExtra() → {Object.<String, String>}

Get the field value Extra info to be stored as part of gateway/card transaction
Source:
Returns:
A map of to <>
Type
Object.<String, String>

(static) CardTransaction#getFirst6() → {String}

Get the field value The first four digits of the card number
Source:
Returns:
Type
String

(static) CardTransaction#getGatewayTxState() → {payments.GatewayTxState}

Get the field value The state as currently recorded. This differs from the legacy 'state' field. The legacy 'state' field is calculated from the 'type' field and whether the transaction was captured.
Source:
Returns:
Type
payments.GatewayTxState

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

Get the field value The last four digits of the card number
Source:
Returns:
Type
String

(static) CardTransaction#getPaymentRef() → {Null|base.Reference}

Get the field value The payment with which the card transaction is associated
Source:
Returns:
Type
Null | base.Reference

(static) CardTransaction#getReferenceId() → {String}

Get the field value
Source:
Returns:
Type
String

(static) CardTransaction#getState() → {payments.CardTransactionState}

Get the field value A state inferred from transaction type and whether the gateway captured the transaction
Source:
Returns:
Type
payments.CardTransactionState

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

Get the field value
Source:
Returns:
Type
String

(static) CardTransaction#getTransactionNo() → {String}

Get the field value
Source:
Returns:
Type
String

(static) CardTransaction#getType() → {payments.CardTransactionType}

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

(static) CardTransaction#getVaultedCard() → {Null|payments.VaultedCard}

Get the field value Vaulted card which can be used for subsequent transactions
Source:
Returns:
Type
Null | payments.VaultedCard

(static) CardTransaction#setAuthCode(authCode)

Set the field value Authorization code (if successful)
Parameters:
Name Type Description
authCode String
Source:

(static) CardTransaction#setAvsResult(avsResult)

Set the field value
Parameters:
Name Type Description
avsResult payments.AVSResult
Source:

(static) CardTransaction#setBegBalance(begBalance)

Set the field value
Parameters:
Name Type Description
begBalance Number | Null must be a long integer,
Source:

(static) CardTransaction#setCardholderName(cardholderName)

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

(static) CardTransaction#setCardType(cardType)

Set the field value
Parameters:
Name Type Description
cardType payments.CardType
Source:

(static) CardTransaction#setCreditRef(creditRef)

Set the field value The credit with which the card transaction is associated
Parameters:
Name Type Description
creditRef Null | base.Reference
Source:

(static) CardTransaction#setCurrency(currency)

Set the field value Currency code
Parameters:
Name Type Description
currency String
Source:

(static) CardTransaction#setEndBalance(endBalance)

Set the field value
Parameters:
Name Type Description
endBalance Number | Null must be a long integer,
Source:

(static) CardTransaction#setEntryType(entryType)

Set the field value
Parameters:
Name Type Description
entryType payments.CardEntryType
Source:

(static) CardTransaction#setExtra(extra)

Set the field value Extra info to be stored as part of gateway/card transaction
Parameters:
Name Type Description
extra Object.<String, String> A map of to <>
Source:

(static) CardTransaction#setFirst6(first6)

Set the field value The first four digits of the card number
Parameters:
Name Type Description
first6 String
Source:

(static) CardTransaction#setGatewayTxState(gatewayTxState)

Set the field value The state as currently recorded. This differs from the legacy 'state' field. The legacy 'state' field is calculated from the 'type' field and whether the transaction was captured.
Parameters:
Name Type Description
gatewayTxState payments.GatewayTxState
Source:

(static) CardTransaction#setLast4(last4)

Set the field value The last four digits of the card number
Parameters:
Name Type Description
last4 String
Source:

(static) CardTransaction#setPaymentRef(paymentRef)

Set the field value The payment with which the card transaction is associated
Parameters:
Name Type Description
paymentRef Null | base.Reference
Source:

(static) CardTransaction#setReferenceId(referenceId)

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

(static) CardTransaction#setState(state)

Set the field value A state inferred from transaction type and whether the gateway captured the transaction
Parameters:
Name Type Description
state payments.CardTransactionState
Source:

(static) CardTransaction#setToken(token)

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

(static) CardTransaction#setTransactionNo(transactionNo)

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

(static) CardTransaction#setType(type)

Set the field value
Parameters:
Name Type Description
type payments.CardTransactionType
Source:

(static) CardTransaction#setVaultedCard(vaultedCard)

Set the field value Vaulted card which can be used for subsequent transactions
Parameters:
Name Type Description
vaultedCard Null | payments.VaultedCard
Source: