Overview
  • Namespace
  • Class

Namespaces

  • Mypos
    • IPC

Classes

  • Authorization
  • AuthorizationCapture
  • AuthorizationList
  • AuthorizationReverse
  • Base
  • Card
  • CardStore
  • Cart
  • Config
  • Customer
  • Defines
  • GetPaymentStatus
  • GetTxnStatus
  • Helper
  • IAPreAuthorization
  • IAPurchase
  • IAStoreCard
  • IAStoredCardUpdate
  • IPCGetTxnLog
  • Loader
  • MandateManagement
  • PreAuthorization
  • PreAuthorizationCancellation
  • PreAuthorizationCompletion
  • PreAuthorizationStatus
  • Purchase
  • PurchaseByIcard
  • Refund
  • RequestMoney
  • Response
  • Reversal

Exceptions

  • IPC_Exception

Class PreAuthorization

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

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

Methods summary

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

Return PreAuthorization object

Return PreAuthorization object

Parameters

$cnf
public Mypos\IPC\PreAuthorization
# setOrderID( string $orderID )

PreAuthorization identifier - must be unique

PreAuthorization identifier - must be unique

Parameters

$orderID

Returns

Mypos\IPC\PreAuthorization
public Mypos\IPC\PreAuthorization
# setItemName( string $itemName )

Parameters

$itemName

Returns

Mypos\IPC\PreAuthorization
public Mypos\IPC\PreAuthorization
# setAmount( float $amount )

Total amount of the PreAuthorization

Total amount of the PreAuthorization

Parameters

$amount

Returns

Mypos\IPC\PreAuthorization
public Mypos\IPC\PreAuthorization
# setNote( string $note )

Optional note for PreAuthorization

Optional note for PreAuthorization

Parameters

$note

Returns

Mypos\IPC\PreAuthorization
public Mypos\IPC\PreAuthorization
# setUrlCancel( string $urlCancel )

Merchant Site URL where client comes after unsuccessful payment

Merchant Site URL where client comes after unsuccessful payment

Parameters

$urlCancel

Returns

Mypos\IPC\PreAuthorization
public Mypos\IPC\PreAuthorization
# setUrlNotify( string $urlNotify )

Merchant Site URL where IPC posts PreAuthorization Notify requests

Merchant Site URL where IPC posts PreAuthorization Notify requests

Parameters

$urlNotify

Returns

Mypos\IPC\PreAuthorization
public boolean
# process( )

Initiate API request

Initiate API request

Returns

boolean

Throws

Mypos\IPC\IPC_Exception
public boolean
# validate( )

Validate all set PreAuthorization details

Validate all set PreAuthorization details

Returns

boolean

Throws

Mypos\IPC\IPC_Exception
public string
# getUrlCancel( )

Merchant Site URL where client comes after unsuccessful payment

Merchant Site URL where client comes after unsuccessful payment

Returns

string
public
# getUrlNotify( )

Merchant Site URL where IPC posts PreAuthorization Notify requests

Merchant Site URL where IPC posts PreAuthorization Notify requests

Var

string
public string
# getUrlOk( )

Merchant Site URL where client comes after successful payment

Merchant Site URL where client comes after successful payment

Returns

string
public Mypos\IPC\PreAuthorization
# setUrlOk( string $urlOk )

Merchant Site URL where client comes after successful payment

Merchant Site URL where client comes after successful payment

Parameters

$urlOk

Returns

Mypos\IPC\PreAuthorization
public string
# getCurrency( )

ISO-4217 Three letter currency code

ISO-4217 Three letter currency code

Returns

string
public Mypos\IPC\PreAuthorization
# setCurrency( string $currency )

ISO-4217 Three letter currency code

ISO-4217 Three letter currency code

Parameters

$currency

Returns

Mypos\IPC\PreAuthorization
public string
# getOrderID( )

PreAuthorization identifier

PreAuthorization identifier

Returns

string
public string
# getItemName( )

Returns

string
public float
# getAmount( )

Total amount of the PreAuthorization

Total amount of the PreAuthorization

Returns

float
public string
# getNote( )

Optional note to PreAuthorization

Optional note to PreAuthorization

Returns

string

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