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 MandateManagement

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

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

Methods summary

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

Return Refund object

Return Refund object

Parameters

$cnf
public string
# getMandateReferece( )

Unique identifier of the agreement (mandate) between the merchant and the client (debtor). Up to 127 characters.

Unique identifier of the agreement (mandate) between the merchant and the client (debtor). Up to 127 characters.

Returns

string
public
# setMandateReferece( string $mandateReferece )

Unique identifier of the agreement (mandate) between the merchant and the client (debtor). Up to 127 characters.

Unique identifier of the agreement (mandate) between the merchant and the client (debtor). Up to 127 characters.

Parameters

$mandateReferece
public string
# getCustomerWalletNumber( )

Identifier of the client’s (debtor’s) myPOS account

Identifier of the client’s (debtor’s) myPOS account

Returns

string
public
# setCustomerWalletNumber( string $customerWalletNumber )

Identifier of the client’s (debtor’s) myPOS account

Identifier of the client’s (debtor’s) myPOS account

Parameters

$customerWalletNumber
public integer
# getAction( )

Registration / Cancellation of a MandateReference

Registration / Cancellation of a MandateReference

Returns

integer
public
# setAction( integer $action )

Registration / Cancellation of a MandateReference

Registration / Cancellation of a MandateReference

Parameters

$action
public string
# getMandateText( )

Text supplied from the merchant, so the client can easily identify the Mandate.

Text supplied from the merchant, so the client can easily identify the Mandate.

Returns

string
public
# setMandateText( string $mandateText )

Text supplied from the merchant, so the client can easily identify the Mandate.

Text supplied from the merchant, so the client can easily identify the Mandate.

Parameters

$mandateText
public Mypos\IPC\Response
# process( )

Initiate API request

Initiate API request

Returns

Mypos\IPC\Response
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()

Constants summary

integer MANDATE_MANAGEMENT_ACTION_REGISTER
# 1
integer MANDATE_MANAGEMENT_ACTION_CANCEL
# 2

Properties summary

Properties inherited from Mypos\IPC\Base

$outputFormat

API documentation generated by ApiGen