Overview
  • Namespace
  • Class

Namespaces

  • Mypos
    • IPC

Classes

  • Base
  • Card
  • CardStore
  • Cart
  • Config
  • Customer
  • Defines
  • GetTxnStatus
  • Helper
  • IAPurchase
  • IAStoreCard
  • IAStoredCardUpdate
  • IPCGetTxnLog
  • Loader
  • MandateManagement
  • Purchase
  • Refund
  • RequestMoney
  • Response
  • Reversal

Exceptions

  • IPC_Exception

Class Refund

Process IPC method: IPCRefund. Collect, validate and send API params

Mypos\IPC\Base
Extended by Mypos\IPC\Refund
Namespace: Mypos\IPC
Located at Refund.php

Methods summary

public
# __construct( Mypos\IPC\Config $cnf )

Return Refund object

Return Refund object

Parameters

$cnf
public
# setAmount( float $amount )

Refund amount

Refund amount

Parameters

$amount
public float
# getAmount( )

Refund amount

Refund amount

Returns

float
public Mypos\IPC\Refund
# setCurrency( string $currency )

ISO-4217 Three letter currency code

ISO-4217 Three letter currency code

Parameters

$currency

Returns

Mypos\IPC\Refund
public string
# getCurrency( )

ISO-4217 Three letter currency code

ISO-4217 Three letter currency code

Returns

string
public Mypos\IPC\Refund
# setTrnref( string $trnref )

Transaction reference - transaction unique identifier

Transaction reference - transaction unique identifier

Parameters

$trnref

Returns

Mypos\IPC\Refund
public string
# getTrnref( )

Transaction reference - transaction unique identifier

Transaction reference - transaction unique identifier

Returns

string
public Mypos\IPC\Refund
# setOrderID( string $orderID )

Request identifier - must be unique

Request identifier - must be unique

Parameters

$orderID

Returns

Mypos\IPC\Refund
public string
# getOrderID( )

Request identifier - must be unique

Request identifier - must be unique

Returns

string
public boolean
# process( )

Initiate API request

Initiate API request

Returns

boolean
public boolean
# validate( )

Validate all set refund details

Validate all set refund details

Returns

boolean

Throws

Mypos\IPC\IPC_Exception

Methods inherited from Mypos\IPC\Base

_addPostParam(), _processHtmlPost(), _processPost(), getCnf(), getOutputFormat(), isValidSignature(), setCnf(), setOutputFormat()

Properties summary

Properties inherited from Mypos\IPC\Base

$outputFormat

API documentation generated by ApiGen