Documentation

Amount extends UbexPayModel

Class Amount, Order Amount

Table of Contents

$currency  : string
$prop  : array<string|int, mixed>
$totalAmount  : float
__construct()  : mixed
Set class properties and methods
execute()  : mixed
Makes the API request
getCurrency()  : string
Get the order currency
getTotal()  : string
Get the order currency
setCurrency()  : Amount
Set the order currency
setTotal()  : Amount
Set the order total

Properties

$currency

public string $currency

Order Currency

$prop

public array<string|int, mixed> $prop

Class properties

$totalAmount

public float $totalAmount

Total Order Amount

Methods

__construct()

Set class properties and methods

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

data

Return values
mixed

execute()

Makes the API request

public execute(string $url, string $method, mixed $payload[, mixed $headers = null ]) : mixed
Parameters
$url : string

Request url

$method : string

Request method POST or GET

$payload : mixed

Request Body

$headers : mixed = null
Return values
mixed

Server response

getCurrency()

Get the order currency

public getCurrency() : string
Return values
string

$currency Order currency

getTotal()

Get the order currency

public getTotal() : string
Return values
string

$totalAmount Order total amount

setCurrency()

Set the order currency

public setCurrency(string $currency) : Amount
Parameters
$currency : string

order currency

Return values
Amount

Amount object

setTotal()

Set the order total

public setTotal(float $amount) : Amount
Parameters
$amount : float

Order Amount

Return values
Amount

Amount Object

Search results