Dotpay SDK
Back to top  

Transfer

Informations about a payout transfer.

package

Default

Methods

Initialize the model.

__construct(float $amount, mixed $control, \Dotpay\Model\BankAccount $recipient)

Arguments

$amount

float

$control

mixed

$recipient

\Dotpay\Model\BankAccount

Return an amount of money.

getAmount() : float

Response

float

Return a control identifier for the transfer.

getControl() : mixed

Response

mixed

Return a description of the transfer.

getDescription() : string

Response

string

Return a bank account of the recipient.

getRecipient() : \Dotpay\Model\BankAccount

Response

\Dotpay\Model\BankAccount

Set an amount of money.

setAmount(float $amount) : \Dotpay\Model\Transfer
Throws
\Dotpay\Exception\BadParameter\AmountException

Thrown when the given amount is incorrect

Arguments

$amount

float

Amount of money

Response

\Dotpay\Model\Transfer

Set a control identifier for the transfer.

setControl(mixed $control) : \Dotpay\Model\Transfer

Arguments

$control

mixed

Control identifier for the transfer

Response

\Dotpay\Model\Transfer

Set a description of the transfer.

setDescription(string $description) : \Dotpay\Model\Transfer

Arguments

$description

string

Description of the transfer

Response

\Dotpay\Model\Transfer

Set a bank account of the recipient.

setRecipient(\Dotpay\Model\BankAccount $recipient) : \Dotpay\Model\Transfer

Arguments

$recipient

\Dotpay\Model\BankAccount

Bank account of the recipient

Response

\Dotpay\Model\Transfer

Properties

Amount of money

amount : float
var

Amount of money

Type(s)

float

Control identifier for the transfer

control : mixed
var

Control identifier for the transfer

Type(s)

mixed

Bank account of the recipient

recipient : \Dotpay\Model\BankAccount
var

Bank account of the recipient

Type(s)

\Dotpay\Model\BankAccount

Description of the transfer

description : string
var

Description of the transfer

Type(s)

string