Dotpay SDK
Back to top  

Refund

Model of refund data.

package

Default

Methods

Initialize the object model.

__construct(string $payment, float $amount, string $control = '', string $description = '')

Arguments

$payment

string

Number of payment which is refunded

$amount

float

Amount of the refund

$control

string

Value which is used by comfirmation of the operation

$description

string

Description of refund

Return an amount of refund.

getAmount() : float

Response

float

Return a value which is used by comfirmation of the operation.

getControl() : mixed

Response

mixed

Return a descriptiion of the refund.

getDescription() : string

Response

string

Return a number of payment for which is the refund.

getPayment() : string

Response

string

Set an amount of refund.

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

Thrown when the given amount is incorrect

Arguments

$amount

float

Amount of refund

Response

\Dotpay\Model\Refund

Set a value which is used by comfirmation of the operation.

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

Arguments

$control

mixed

Value which is used by comfirmation of the operation

Response

\Dotpay\Model\Refund

Set a description of the refund.

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

Arguments

$description

string

Descriptiion of the refund

Response

\Dotpay\Model\Refund

Set a number of payment for which is the refund.

setPayment(string $payment) : \Dotpay\Model\Refund
Throws
\Dotpay\Exception\BadParameter\OperationNumberException

Thrown when the given operation number is incorrect

Arguments

$payment

string

Number of payment for which is the refund

Response

\Dotpay\Model\Refund

Properties

Number of payment for which is the refund

payment : string
var

Number of payment for which is the refund

Type(s)

string

Amount of refund

amount : float
var

Amount of refund

Type(s)

float

Value which is used by comfirmation of the operation

control : string
var

Value which is used by comfirmation of the operation

Type(s)

string

Descriptiion of the refund

description : string
var

Descriptiion of the refund

Type(s)

string