Class Syspay_Merchant_Entity_PaymentRecipient

A payment recipient object (to use for recipient_map)

Syspay_Merchant_Entity

Extended by

Syspay_Merchant_Entity_PaymentRecipient

Located at Syspay/SDK/Merchant/Entity/PaymentRecipient.php

Methods summary
`public integer`	# `getUserId( )` Gets the The SysPay user id of the recipient. This is used as verification to make sure the recipient's account_id is not bogus. Gets the The SysPay user id of the recipient. This is used as verification to make sure the recipient's account_id is not bogus. Returns `integer` integer
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setUserId( integer $user_id )` Sets the The SysPay user id of the recipient. This is used as verification to make sure the recipient's account_id is not bogus. Sets the The SysPay user id of the recipient. This is used as verification to make sure the recipient's account_id is not bogus. Parameters `$user_id` the user_id Returns `Syspay_Merchant_Entity_PaymentRecipient` self
`public integer`	# `getAccountId( )` Gets the The SysPay account id of the recipient. Gets the The SysPay account id of the recipient. Returns `integer` integer
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setAccountId( integer $account_id )` Sets the The SysPay account id of the recipient. Sets the The SysPay account id of the recipient. Parameters `$account_id` the account_id Returns `Syspay_Merchant_Entity_PaymentRecipient` self
`public integer`	# `getCalcType( )` Gets the The way the amount to transfer to the recipient is calculated. (one of the CALC_TYPE constants) CALC_TYPE_PERCENT: The `value` property is a (percentage100) of the total payment amount CALC_TYPE_FIXED: The 'value' property is a fixed amount. In this case the 'currency' must be given. Gets the The way the amount to transfer to the recipient is calculated. (one of the CALC_TYPE constants) CALC_TYPE_PERCENT: The `value` property is a (percentage100) of the total payment amount CALC_TYPE_FIXED: The 'value' property is a fixed amount. In this case the 'currency' must be given. Returns `integer` integer
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setCalcType( integer $calc_type )` Sets the The way the amount to transfer to the recipient is calculated. (one of the CALC_TYPE constants) CALC_TYPE_PERCENT: The `value` property is a (percentage100) of the total payment amount CALC_TYPE_FIXED: The 'value' property is a fixed amount. In this case the 'currency' must be given. Sets the The way the amount to transfer to the recipient is calculated. (one of the CALC_TYPE constants) CALC_TYPE_PERCENT: The `value` property is a (percentage100) of the total payment amount CALC_TYPE_FIXED: The 'value' property is a fixed amount. In this case the 'currency' must be given. Parameters `$calc_type` the calc_type Returns `Syspay_Merchant_Entity_PaymentRecipient` self
`public integer`	# `getValue( )` Gets the Value used to compute the amount. Gets the Value used to compute the amount. Returns `integer` integer
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setValue( integer $value )` Sets the Value used to compute the amount. Sets the Value used to compute the amount. Parameters `$value` the value Returns `Syspay_Merchant_Entity_PaymentRecipient` self
`public string`	# `getCurrency( )` Gets the The currency (mandatory in case of a FIXED calc_type) This is a safety check and it must match the payment currency.. Gets the The currency (mandatory in case of a FIXED calc_type) This is a safety check and it must match the payment currency.. Returns `string` string
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setCurrency( string $currency )` Sets the The currency (mandatory in case of a FIXED calc_type) This is a safety check and it must match the payment currency.. Sets the The currency (mandatory in case of a FIXED calc_type) This is a safety check and it must match the payment currency.. Parameters `$currency` the currency Returns `Syspay_Merchant_Entity_PaymentRecipient` self
`public integer`	# `getSettlementDelay( )` Gets the Number of seconds to delay the transfer's settlement (added to the actual time of settlement of the payment). Gets the Number of seconds to delay the transfer's settlement (added to the actual time of settlement of the payment). Returns `integer` integer
`public Syspay_Merchant_Entity_PaymentRecipient`	# `setSettlementDelay( integer $settlement_delay )` Sets the Number of seconds to delay the transfer's settlement (added to the actual time of settlement of the payment). Sets the Number of seconds to delay the transfer's settlement (added to the actual time of settlement of the payment). Parameters `$settlement_delay` the settlement_delay Returns `Syspay_Merchant_Entity_PaymentRecipient` self

Methods inherited from Syspay_Merchant_Entity
`getType(), toArray()`

Constants summary
`string`	`TYPE`	#`'payment_recipient'`
`string`	`CALC_TYPE_FIXED` The exact amount is given (the 'value' property is an amount in CENTs and the 'currency' must be supplied) The exact amount is given (the 'value' property is an amount in CENTs and the 'currency' must be supplied)	#`'fixed'`
`string`	`CALC_TYPE_PERCENT` The 'value' is a percentage * 100 (100 == 1%) of the total payment amount The 'value' is a percentage * 100 (100 == 1%) of the total payment amount	#`'percent'`

Properties inherited from Syspay_Merchant_Entity
`$raw`