Dotpay SDK
Back to top  

Notification

Informations about a notification from Dotpay server.

package

Default

Methods

Initialize the model.

__construct(\Dotpay\Model\Operation $operation, integer $channel = null)

Arguments

$operation

\Dotpay\Model\Operation

Details of operation which relates the notification

$channel

integer

Id of used payment channel

Calculate a signature based on data from the notification and the given seller pin.

calculateSignature(string $pin) : string

Arguments

$pin

string

Seller pin

Response

string

Create the model based on data provided from shop.

createFromData(\Dotpay\Provider\NotificationProviderInterface $provider) : \Dotpay\Model\Notification
static

Arguments

$provider

\Dotpay\Provider\NotificationProviderInterface

Provider which contains data from shop application

Response

\Dotpay\Model\Notification

Return a codename of a country of the payment instrument from which payment was made.

getChannelCountry() : string

Response

string

Return an id of used payment channel.

getChannelId() : integer

Response

integer

Return a CreditCard object if payment was realize by credit card and this information is allowed to send.

getCreditCard() : \Dotpay\Model\CreditCard|null

Response

\Dotpay\Model\CreditCard|null

Return a codename of a country resulting from IP address from which the payment was made.

getIpCountry() : string

Response

string

Return an Operation object with details of operation which relates the notification.

getOperation() : \Dotpay\Model\Operation

Response

\Dotpay\Model\Operation

Return an email of a seller.

getShopEmail() : string

Response

string

Return a name of a shop.

getShopName() : string

Response

string

Return a checksum of a Dotpay notification.

getSignature() : string

Response

string

Set a codename of a country of the payment instrument from which payment was made.

setChannelCountry(string $channelCountry) : \Dotpay\Model\Notification

Arguments

$channelCountry

string

Codename of a country of the payment instrument from which payment was made

Response

\Dotpay\Model\Notification

Set an id of used payment channel.

setChannelId(integer $channelId) : \Dotpay\Model\Notification
Throws
\Dotpay\Exception\BadParameter\ChannelIdException

Thrown when the given channel id is incorrect

Arguments

$channelId

integer

Id of used payment channel

Response

\Dotpay\Model\Notification

Set a CreditCard object if payment was realize by credit card and this information is allowed to send.

setCreditCard(\Dotpay\Model\CreditCard $creditCard) : \Dotpay\Model\Notification

Arguments

$creditCard

\Dotpay\Model\CreditCard

CreditCard object if payment was realize by credit card and this information is allowed to send

Response

\Dotpay\Model\Notification

Set a codename of a country resulting from IP address from which the payment was made.

setIpCountry(string $ipCountry) : \Dotpay\Model\Notification

Arguments

$ipCountry

string

Codename of a country resulting from IP address from which the payment was made

Response

\Dotpay\Model\Notification

Set an Operation object with details of operation which relates the notification.

setOperation(\Dotpay\Model\Operation $operation) : \Dotpay\Model\Notification

Arguments

$operation

\Dotpay\Model\Operation

Operation object with details of operation which relates the notification

Response

\Dotpay\Model\Notification

Set an email of a seller.

setShopEmail(string $shopEmail) : \Dotpay\Model\Notification
Throws
\Dotpay\Exception\BadParameter\EmailException

Thrown when the given seller email is incorrect

Arguments

$shopEmail

string

Email of a seller

Response

\Dotpay\Model\Notification

Set a name of a shop.

setShopName(string $shopName) : \Dotpay\Model\Notification

Arguments

$shopName

string

Name of a shop

Response

\Dotpay\Model\Notification

Set a checksum of a Dotpay notification.

setSignature(string $signature) : \Dotpay\Model\Notification

Arguments

$signature

string

Checksum of a Dotpay notification

Response

\Dotpay\Model\Notification

Properties

Operation object with details of operation which relates the notification

operation : \Dotpay\Model\Operation
var

Operation object with details of operation which relates the notification

Type(s)

\Dotpay\Model\Operation

Email of a seller

shopEmail : string
var

Email of a seller

Type(s)

string

Name of a shop

shopName : string
var

Name of a shop

Type(s)

string

Id of used payment channel

channelId : integer
var

Id of used payment channel

Type(s)

integer

Codename of a country of the payment instrument from which payment was made

channelCountry : string
var

Codename of a country of the payment instrument from which payment was made

Type(s)

string

Codename of a country resulting from IP address from which the payment was made

ipCountry : string
var

Codename of a country resulting from IP address from which the payment was made

Type(s)

string

CreditCard object if payment was realize by credit card and this information is allowed to send

creditCard : \Dotpay\Model\CreditCard|null
var

CreditCard object if payment was realize by credit card and this information is allowed to send

Type(s)

\Dotpay\Model\CreditCard|null

Checksum of a Dotpay notification

signature : string
var

Checksum of a Dotpay notification

Type(s)

string