Class corerefund

Inheritance diagram for com.payments.core.CoreRefund:

Public Member Functions

CoreRefund (BigDecimal amount)
CoreRefund (BigDecimal amount, String orderId)
void setUniqueRef (String uniqueRef)
String getUniqueRef ()
void setReason (String reason)
String getReason ()
BigDecimal getAmount ()
String getOrderId ()
Boolean getAutoReady ()
void setAutoReady (Boolean autoReady)
String getOperator ()
void setOperator (String operator)

Detailed Description

This class represents referenced refund object.

CoreRefund refund = new CoreRefund(1.12);
refund.setUniqueRef("B5EOFKJ84W");
refund.setReason("reason");
AndroidTerminal.getInstance().processSale(refund);
// or if you use Java, use JavaTerminal.getInstance().processSale(refund);

Constructor & Destructor Documentation

CoreRefund() [1/2]

    • com.payments.core.CoreRefund.CoreRefund
    • (
    • BigDecimal
    • amount
    • )

  • inline

Constructor 1 initialises a new instance of a CoreRefund class.

Parameters

  • amount
  • of a transaction which is mandatory.

CoreRefund() [2/2]

    • com.payments.core.CoreRefund.CoreRefund
    • (
    • BigDecimal
    • amount,

    • String
    • orderId

    • )

  • inline

Constructor 2 initialises a new instance of a CoreRefund class..

Parameters

  • amount
  • of a transaction which is mandatory.

  • orderId
  • holds order ID.

Member Function Documentation

getAmount()

    • BigDecimal com.payments.core.CoreRefund.getAmount
    • (
    • )

  • inline

The BigDecimal represents sale amount set for each transaction.

Returns

amount of a transaction

getAutoReady()

    • Boolean com.payments.core.CoreRefund.getAutoReady
    • (
    • )

  • inline

The Boolean represents auto ready when it is set to true transactions are automatically set to ready status in the open batch recommended(set autoReady to true).

Returns

autoReady

getOperator()

    • String com.payments.core.CoreRefund.getOperator
    • (
    • )

  • inline

The Boolean represents operator.

Returns

operator

getOrderId()

    • String com.payments.core.CoreRefund.getOrderId
    • (
    • )

  • inline

The String represents order Id assigned to each transaction.

Returns

orderId

getReason()

    • String com.payments.core.CoreRefund.getReason
    • (
    • )

  • inline

This String represents reason why refund has been requested.

Returns

reason why you want to refund this transaction

getUniqueRef()

    • String com.payments.core.CoreRefund.getUniqueRef
    • (
    • )

  • inline

This String represents unique reference assigned to each transaction.

Returns

uniqueRef - unique reference

setAutoReady()

    • void com.payments.core.CoreRefund.setAutoReady
    • (
    • Boolean
    • autoReady
    • )

  • inline

Sets the value of the autoReady property.

Parameters

  • autoReady

setOperator()

    • void com.payments.core.CoreRefund.setOperator
    • (
    • String
    • operator
    • )

  • inline

Sets the value of the operator property.

Parameters

  • operator

setReason()

    • void com.payments.core.CoreRefund.setReason
    • (
    • String
    • reason
    • )

  • inline

Sets the value of reason property.

Parameters

  • reason
  • to refund the transaction

setUniqueRef()

    • void com.payments.core.CoreRefund.setUniqueRef
    • (
    • String
    • uniqueRef
    • )

  • inline

Sets the value of uniqueRef property.

Parameters

  • uniqueRef
  • - unique reference