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
Returns
|
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
|
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 (percentage*100) 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 (percentage*100) 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 (percentage*100) 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 (percentage*100) of
the total payment amount
- CALC_TYPE_FIXED: The 'value' property is a fixed amount. In this case the
'currency' must be given.
Parameters
Returns
|
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
Returns
|
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
Returns
|
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
|