Dotpay SDK
Back to top  

Request

Class which contains data used for creating a payment request.

package

Default

Methods

Initialize the request.

__construct(integer $sellerId, boolean $testMode, float $amount = 300, string $currency = 'PLN', string $language = 'pl')

Arguments

$sellerId

integer

Seller id

$testMode

boolean

Flag if test mode is activated

$amount

float

Amount of the request

$currency

string

Currency code of the request

$language

string

Language used by the customer

Return amount of the request.

getAmount() : float

Response

float

Return currency code of the request.

getCurrency() : string

Response

string

Return format of expected response.

getFormat() : string

Response

string

Create request object based on povided data.

getFromData(integer $sellerId, boolean $testMode, float $amount, string $currency, string $language) : \Dotpay\Resource\Channel\Request
static

Arguments

$sellerId

integer

Seller id

$testMode

boolean

Flag if test mode is activated

$amount

float

Amount of the request

$currency

string

Currency code of the request

$language

string

Language used by the customer

Response

\Dotpay\Resource\Channel\Request

Create request object based on seller account data.

getFromSellerId(integer $sellerId, boolean $testMode) : \Dotpay\Resource\Channel\Request
static

Arguments

$sellerId

integer

Seller id

$testMode

boolean

Flag if test mode is activated

Response

\Dotpay\Resource\Channel\Request

Creates an object of Request based on data given in transaction object.

getFromTransaction(\Dotpay\Model\Transaction $transaction) : \Dotpay\Resource\Channel\Request
static

Arguments

$transaction

\Dotpay\Model\Transaction

Data of transaction

Response

\Dotpay\Resource\Channel\Request

Return an identifier of the request.

getIdentifier() : string

Response

string

Return language used by the customer.

getLanguage() : string

Response

string

Return query string for the payment request.

getQueryString() : string

Response

string

Return seller id.

getSellerId() : integer

Response

integer

Return full url of the request.

getUrl() : string

Response

string

Return a flag if test mode is used or not.

isTestMode() : boolean

Response

boolean

Set an amount of the request.

setAmount(float $amount) : \Dotpay\Resource\Channel\Order
Throws
\Dotpay\Exception\BadParameter\AmountException

Thrown when the given amount is incorrect

Arguments

$amount

float

An amount of the request

Response

\Dotpay\Resource\Channel\Order

Set a currency code of the request.

setCurrency(string $currency) : \Dotpay\Resource\Channel\Order
Throws
\Dotpay\Exception\BadParameter\CurrencyException

Thrown when the given currency is incorrect

Arguments

$currency

string

A currency code of the request

Response

\Dotpay\Resource\Channel\Order

Set a format of expected response.

setFormat(string $format) : \Dotpay\Resource\Channel\Request
Throws
\Dotpay\Exception\BadParameter\RequestFormatException

Thrown when the given format is incorrect

Arguments

$format

string

Format of expected response

Response

\Dotpay\Resource\Channel\Request

Set a language used by the customer.

setLanguage(string $language) : \Dotpay\Resource\Channel\Request
Throws
\Dotpay\Exception\BadParameter\LanguageException

Thrown when the given language is incorrect

Arguments

$language

string

Language used by the customer

Response

\Dotpay\Resource\Channel\Request

Set a seller id.

setSellerId(integer $sellerId) : \Dotpay\Resource\Channel\Seller
Throws
\Dotpay\Exception\BadParameter\IdException

Thrown when the given seller id is incorrect

Arguments

$sellerId

integer

Seller id

Response

\Dotpay\Resource\Channel\Seller

Set a flag if test mode is used or not.

setTestMode(boolean $testMode) : \Dotpay\Resource\Channel\Request

Arguments

$testMode

boolean

Flag if test mode is used or not

Response

\Dotpay\Resource\Channel\Request

Properties

Possible formats of expected response

AVAILABLE_FORMATS : array
static
var

Possible formats of expected response

Type(s)

array

Seller id

sellerId : integer
var

Seller id

Type(s)

integer

Amount of the request

amount : float
var

Amount of the request

Type(s)

float

Currency code of the request

currency : string
var

Currency code of the request

Type(s)

string

Language used by the customer

language : string
var

Language used by the customer

Type(s)

string

A flag if test mode is used or not

testMode : boolean
var

A flag if test mode is used or not

Type(s)

boolean

Format of expected response

format : string
var

Format of expected response

Type(s)

string