CancellationRequest

Extends \NextEvent\PHPSDK\Model\Model

Cancellation request model

Represents a cancellation request for a given order. Can be used to confirm cancellation in a second step.

package	NextEvent\PHPSDK\Model

Methods

Supports getX or hasX Methods for properties which are yet unknown.

__call(string $name, array $args) : mixed

inherited

If the source of your model contains, e.g. a property named 'my_property', you can call getMyProperty() to retrieve it's value.

Arguments

$name

string

$args

array

Response

mixed

Model constructor

__construct(array $source)

inherited

Parse source data.


Throws	\NextEvent\PHPSDK\Exception\InvalidModelDataException

Arguments

$source

array

The source data as received from the API

Get the value for the given variable.

get(string $var) : mixed

inherited

Should be used, if you expect the model to have custom properties which are not known/covered by the known getters

Arguments

$var

string

Response

mixed

Get the authorization code

getAuthorization() : string

Used for order settlement

Response

string

Get the currency of the refund amount

getCurrency() : string

Returns an alphanumeric currency code according to ISO 4217.

Response

string

Get the order identifier of this cancellation

getOrderId() : integer

Response

integer

Get the total amount to be refunded when cancelling the order

getRefundAmount() : float

Response

float

Get the data to be submitted for completing the cancellation

getSettlementData(string $reason = '') : array

Arguments

$reason

string

Description why this order is cancelled

Response

array

Hash array to be submitted as POST data

Check model state if it is valid

isValid() : boolean

inherited abstract

Response

boolean

String representation of object

serialize() : string

inherited

Implements Serializable interface

Response

string

Convert model to an Array

toArray() : array

inherited

Response

array

Convert the model for logging

toLogContext() : array

inherited

Implements the LogContextInterface interface

Response

array

Represent the model as string

toString() : string

inherited

Response

string

Constructs the object from a string

unserialize( $serialized)

inherited

Implements Serializable interface