Class Purchase

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

Mypos\IPC\Purchase

Namespace: Mypos\IPC
Located at Purchase.php

Methods summary

`public`	# `__construct( Mypos\IPC\Config $cnf )` Return purchase object Return purchase object Parameters `$cnf`
`public Mypos\IPC\Purchase`	# `setOrderID( string $orderID )` Purchase identifier - must be unique Purchase identifier - must be unique Parameters `$orderID` Returns `Mypos\IPC\Purchase`
`public string`	# `getOrderID( )` Purchase identifier Purchase identifier Returns string
`public Mypos\IPC\Purchase`	# `setNote( string $note )` Optional note to purchase Optional note to purchase Parameters `$note` Returns `Mypos\IPC\Purchase`
`public string`	# `getNote( )` Optional note to purchase Optional note to purchase Returns string
`public Mypos\IPC\Purchase`	# `setCurrency( string $currency )` ISO-4217 Three letter currency code ISO-4217 Three letter currency code Parameters `$currency` Returns `Mypos\IPC\Purchase`
`public string`	# `getCurrency( )` ISO-4217 Three letter currency code ISO-4217 Three letter currency code Returns string
`public Mypos\IPC\Purchase`	# `setCart( Mypos\IPC\Cart $cart )` Cart object Cart object Parameters `$cart` Returns `Mypos\IPC\Purchase`
`public Mypos\IPC\Cart`	# `getCart( )` Cart object Cart object Returns `Mypos\IPC\Cart`
`public Mypos\IPC\Purchase`	# `setCustomer( Mypos\IPC\Customer $customer )` Customer object Customer object Parameters `$customer` Returns `Mypos\IPC\Purchase`
`public Mypos\IPC\Customer`	# `getCustomer( )` Returns `Mypos\IPC\Customer`
`public Mypos\IPC\Config`	# `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\Config`
`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\Config`	# `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\Config`
`public string`	# `getUrlCancel( )` Merchant Site URL where client comes after unsuccessful payment Merchant Site URL where client comes after unsuccessful payment Returns string
`public Mypos\IPC\Config`	# `setUrlNotify( string $urlNotify )` Merchant Site URL where IPC posts Purchase Notify requests Merchant Site URL where IPC posts Purchase Notify requests Parameters `$urlNotify` Returns `Mypos\IPC\Config`
`public`	# `getUrlNotify( )` Merchant Site URL where IPC posts Purchase Notify requests Merchant Site URL where IPC posts Purchase Notify requests Var string
`public integer`	# `getCardTokenRequest( )` Whether to return Card Token for current client card Whether to return Card Token for current client card Returns integer
`public`	# `setCardTokenRequest( integer $cardTokenRequest )` Whether to return Card Token for current client card Whether to return Card Token for current client card Parameters `$cardTokenRequest`
`public integer`	# `getPaymentParametersRequired( )` Defines the packet of details needed from merchant and client to make payment Defines the packet of details needed from merchant and client to make payment Returns integer
`public`	# `setPaymentParametersRequired( integer $paymentParametersRequired )` Defines the packet of details needed from merchant and client to make payment Defines the packet of details needed from merchant and client to make payment Parameters `$paymentParametersRequired`
`public boolean`	# `process( )` Initiate API request Initiate API request Returns boolean
`public boolean`	# `validate( )` Validate all set purchase details Validate all set purchase 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`	`PURCHASE_TYPE_FULL`	# `1`
`integer`	`PURCHASE_TYPE_SIMPLIFIED_CALL`	# `2`
`integer`	`PURCHASE_TYPE_SIMPLIFIED_PAYMENT_PAGE`	# `3`
`integer`	`CARD_TOKEN_REQUSET_NONE`	# `0`
`integer`	`CARD_TOKEN_REQUSET_ONLY_STORE`	# `1`
`integer`	`CARD_TOKEN_REQUSET_PAY_AND_STORE`	# `2`

Properties summary

Properties inherited from Mypos\IPC\Base

$outputFormat

Namespaces

Classes

Exceptions

Class Purchase

Methods summary

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Var

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Methods inherited from Mypos\IPC\Base

Constants summary

Properties summary

Properties inherited from Mypos\IPC\Base