BitPay PHP SDK

Currency
in package

Object containing currency information.

Tags
author

BitPay Integrations integrations@bitpay.com

license

http://www.opensource.org/licenses/mit-license.php MIT

Table of Contents

Constants

AED  = "AED"
AFN  = "AFN"
ALL  = "ALL"
AMD  = "AMD"
ANG  = "ANG"
AOA  = "AOA"
ARS  = "ARS"
AUD  = "AUD"
AWG  = "AWG"
AZN  = "AZN"
BAM  = "BAM"
BBD  = "BBD"
BCH  = "BCH"
BDT  = "BDT"
BGN  = "BGN"
BHD  = "BHD"
BIF  = "BIF"
BMD  = "BMD"
BND  = "BND"
BOB  = "BOB"
BOV  = "BOV"
BRL  = "BRL"
BSD  = "BSD"
BTC  = "BTC"
BTN  = "BTN"
BUSD  = "BUSD"
BWP  = "BWP"
BYR  = "BYR"
BZD  = "BZD"
CAD  = "CAD"
CDF  = "CDF"
CHE  = "CHE"
CHF  = "CHF"
CHW  = "CHW"
CLF  = "CLF"
CLP  = "CLP"
CNY  = "CNY"
COP  = "COP"
COU  = "COU"
CRC  = "CRC"
CUC  = "CUC"
CUP  = "CUP"
CVE  = "CVE"
CZK  = "CZK"
DJF  = "DJF"
DKK  = "DKK"
DOGE  = "DOGE"
DOP  = "DOP"
DZD  = "DZD"
EGP  = "EGP"
ERN  = "ERN"
ETB  = "ETB"
ETH  = "ETH"
EUR  = "EUR"
FJD  = "FJD"
FKP  = "FKP"
GBP  = "GBP"
GEL  = "GEL"
GHS  = "GHS"
GIP  = "GIP"
GMD  = "GMD"
GNF  = "GNF"
GTQ  = "GTQ"
GUSD  = "GUSD"
GYD  = "GYD"
HKD  = "HKD"
HNL  = "HNL"
HRK  = "HRK"
HTG  = "HTG"
HUF  = "HUF"
IDR  = "IDR"
ILS  = "ILS"
INR  = "INR"
IQD  = "IQD"
IRR  = "IRR"
ISK  = "ISK"
JMD  = "JMD"
JOD  = "JOD"
JPY  = "JPY"
KES  = "KES"
KGS  = "KGS"
KHR  = "KHR"
KMF  = "KMF"
KPW  = "KPW"
KRW  = "KRW"
KWD  = "KWD"
KYD  = "KYD"
KZT  = "KZT"
LAK  = "LAK"
LBP  = "LBP"
LKR  = "LKR"
LRD  = "LRD"
LSL  = "LSL"
LTC  = "LTC"
LYD  = "LYD"
MAD  = "MAD"
MDL  = "MDL"
MGA  = "MGA"
MKD  = "MKD"
MMK  = "MMK"
MNT  = "MNT"
MOP  = "MOP"
MRU  = "MRU"
MUR  = "MUR"
MVR  = "MVR"
MWK  = "MWK"
MXN  = "MXN"
MXV  = "MXV"
MYR  = "MYR"
MZN  = "MZN"
NAD  = "NAD"
NGN  = "NGN"
NIO  = "NIO"
NOK  = "NOK"
NPR  = "NPR"
NZD  = "NZD"
OMR  = "OMR"
PAB  = "PAB"
PAX  = "PAX"
PEN  = "PEN"
PGK  = "PGK"
PHP  = "PHP"
PKR  = "PKR"
PLN  = "PLN"
PYG  = "PYG"
QAR  = "QAR"
RON  = "RON"
RSD  = "RSD"
RUB  = "RUB"
RWF  = "RWF"
SAR  = "SAR"
SBD  = "SBD"
SCR  = "SCR"
SDG  = "SDG"
SEK  = "SEK"
SGD  = "SGD"
SHIB  = "SHIB"
SHP  = "SHP"
SLL  = "SLL"
SOS  = "SOS"
SRD  = "SRD"
SSP  = "SSP"
STN  = "STN"
SVC  = "SVC"
SYP  = "SYP"
SZL  = "SZL"
THB  = "THB"
TJS  = "TJS"
TMT  = "TMT"
TND  = "TND"
TOP  = "TOP"
TRY  = "TRY"
TTD  = "TTD"
TWD  = "TWD"
TZS  = "TZS"
UAH  = "UAH"
UGX  = "UGX"
USD  = "USD"
USDC  = "USDC"
USN  = "USN"
UYI  = "UYI"
UYU  = "UYU"
UZS  = "UZS"
VEF  = "VEF"
VND  = "VND"
VUV  = "VUV"
WST  = "WST"
XAF  = "XAF"
XCD  = "XCD"
XDR  = "XDR"
XOF  = "XOF"
XPF  = "XPF"
XRP  = "XRP"
XSU  = "XSU"
XUA  = "XUA"
YER  = "YER"
ZAR  = "ZAR"
ZMW  = "ZMW"
ZWL  = "ZWL"

Properties

$alts  : string|null
$chain  : string|null
$code  : string|null
$contractAddress  : string|null
$currentlySettled  : bool|null
$decimals  : int|null
$displayCode  : string|null
$maxSupply  : string|null
$minimum  : string|null
$name  : string|null
$plural  : string|null
$precision  : int|null
$sanctioned  : bool|null
$symbol  : string|null
$trancheDecimals  : int|null

Methods

__construct()  : mixed
getAlts()  : string|null
Gets alternative currency name(s)
getChain()  : string|null
getCode()  : string|null
Get ISO 4217 3-character currency code
getContractAddress()  : string|null
getCurrentlySettled()  : bool|null
Gets currently settled value
getDecimals()  : int|null
Gets decimal precision
getDisplayCode()  : string|null
getMaxSupply()  : string|null
getMinimum()  : string|null
Gets minimum supported value when creating an invoice, bill or payout for instance
getName()  : string|null
Gets currency name
getPlural()  : string|null
Gets English plural form
getPrecision()  : int|null
Number of decimal places
getSanctioned()  : bool|null
Gets if the currency is linked to a sanctionned country
getSymbol()  : string|null
Display symbol
getTrancheDecimals()  : int|null
isValid()  : bool
Currency validation
setAlts()  : void
Sets alternative currency name(s)
setChain()  : void
setCode()  : void
Sets ISO 4217 3-character currency code
setContractAddress()  : void
setCurrentlySettled()  : void
Sets currently settled value
setDecimals()  : void
Sets decimal precision
setDisplayCode()  : void
setMaxSupply()  : void
setMinimum()  : void
Sets minimum supported value when creating an invoice, bill or payout for instance
setName()  : void
Sets currency name
setPlural()  : void
Sets English plural form
setPrecision()  : void
Sets number of decimal places
setSanctioned()  : void
Sets if the currency is linked to a sanctionned country
setSymbol()  : void
Sets symbol
setTrancheDecimals()  : void
toArray()  : array<string|int, mixed>
Gets currency data as array

Constants

Properties

$alts

protected string|null $alts = null

$chain

protected string|null $chain = null

$code

protected string|null $code = null

$contractAddress

protected string|null $contractAddress = null

$currentlySettled

protected bool|null $currentlySettled = null

$decimals

protected int|null $decimals = null

$displayCode

protected string|null $displayCode = null

$maxSupply

protected string|null $maxSupply = null

$minimum

protected string|null $minimum = null

$name

protected string|null $name = null

$plural

protected string|null $plural = null

$precision

protected int|null $precision = null

$sanctioned

protected bool|null $sanctioned = null

$symbol

protected string|null $symbol = null

$trancheDecimals

protected int|null $trancheDecimals = null

Methods

__construct()

public __construct() : mixed

getAlts()

Gets alternative currency name(s)

public getAlts() : string|null
Return values
string|null

the alts

getChain()

public getChain() : string|null
Return values
string|null

getCode()

Get ISO 4217 3-character currency code

public getCode() : string|null
Return values
string|null

the code

getContractAddress()

public getContractAddress() : string|null
Return values
string|null

getCurrentlySettled()

Gets currently settled value

public getCurrentlySettled() : bool|null
Return values
bool|null

getDecimals()

Gets decimal precision

public getDecimals() : int|null
Return values
int|null

decimals

getDisplayCode()

public getDisplayCode() : string|null
Return values
string|null

getMaxSupply()

public getMaxSupply() : string|null
Return values
string|null

getMinimum()

Gets minimum supported value when creating an invoice, bill or payout for instance

public getMinimum() : string|null
Return values
string|null

the minimum

getName()

Gets currency name

public getName() : string|null
Return values
string|null

the name

getPlural()

Gets English plural form

public getPlural() : string|null
Return values
string|null

the plural form

getPrecision()

Number of decimal places

public getPrecision() : int|null
Return values
int|null

the precision

getSanctioned()

Gets if the currency is linked to a sanctionned country

public getSanctioned() : bool|null
Return values
bool|null

the sanctioned

getSymbol()

Display symbol

public getSymbol() : string|null
Return values
string|null

the symbol

getTrancheDecimals()

public getTrancheDecimals() : int|null
Return values
int|null

isValid()

Currency validation

public static isValid(string $value) : bool
Parameters
$value : string

the currency value

Return values
bool

setAlts()

Sets alternative currency name(s)

public setAlts(string $alts) : void
Parameters
$alts : string

the alts

setChain()

public setChain(string|null $chain) : void
Parameters
$chain : string|null

setCode()

Sets ISO 4217 3-character currency code

public setCode(string $code) : void
Parameters
$code : string

the code

setContractAddress()

public setContractAddress(string|null $contractAddress) : void
Parameters
$contractAddress : string|null

setCurrentlySettled()

Sets currently settled value

public setCurrentlySettled(bool $currentlySettled) : void
Parameters
$currentlySettled : bool

setDecimals()

Sets decimal precision

public setDecimals(int|null $decimals) : void
Parameters
$decimals : int|null

decimals

setDisplayCode()

public setDisplayCode(string|null $displayCode) : void
Parameters
$displayCode : string|null

setMaxSupply()

public setMaxSupply(string|null $maxSupply) : void
Parameters
$maxSupply : string|null

setMinimum()

Sets minimum supported value when creating an invoice, bill or payout for instance

public setMinimum(string $minimum) : void
Parameters
$minimum : string

the minimum

setName()

Sets currency name

public setName(string $name) : void
Parameters
$name : string

the name

setPlural()

Sets English plural form

public setPlural(string $plural) : void
Parameters
$plural : string

the plural form

setPrecision()

Sets number of decimal places

public setPrecision(int $precision) : void
Parameters
$precision : int

the precision

setSanctioned()

Sets if the currency is linked to a sanctionned country

public setSanctioned(bool $sanctioned) : void
Parameters
$sanctioned : bool

the sanctioned

setSymbol()

Sets symbol

public setSymbol([string|null $symbol = null ]) : void
Parameters
$symbol : string|null = null

setTrancheDecimals()

public setTrancheDecimals(int|null $trancheDecimals) : void
Parameters
$trancheDecimals : int|null

toArray()

Gets currency data as array

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

currency data as array


        
On this page

Search results