BitPay PHP SDK

Wallet
in package

Tags
author

BitPay Integrations integrations@bitpay.com

license

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

see
https://bitpay.readme.io/reference/wallets

Wallets

Table of Contents

Properties

$avatar  : string|null
$currencies  : Currencies
$displayName  : string|null
$image  : string|null
$invoiceDefault  : string|null
$key  : string|null
$offChainMode  : bool|null
$payPro  : bool|null
$uniCode  : string|null

Methods

__construct()  : mixed
Constructor, create a minimal request Wallet object.
getAvatar()  : string|null
Gets avatar
getCurrencies()  : Currencies
Gets currencies
getDisplayName()  : string|null
Gets display name
getImage()  : string|null
Gets image
getInvoiceDefault()  : string|null
getKey()  : string|null
Gets A unique identifier for the wallet
getOffChainMode()  : bool|null
getPayPro()  : bool|null
Gets pay pro
getUniCode()  : string|null
setAvatar()  : void
Sets avatar
setCurrencies()  : void
Sets currencies
setDisplayName()  : void
Sets display name
setImage()  : void
Sets image
setInvoiceDefault()  : void
setKey()  : void
Sets A unique identifier for the wallet
setOffChainMode()  : void
setPayPro()  : void
Sets pay pro
setUniCode()  : void
toArray()  : array<string|int, mixed>
Gets Wallet as array

Properties

$avatar

protected string|null $avatar = null

$displayName

protected string|null $displayName = null

$image

protected string|null $image = null

$invoiceDefault

protected string|null $invoiceDefault = null

$key

protected string|null $key = null

$offChainMode

protected bool|null $offChainMode = null

$payPro

protected bool|null $payPro = null

$uniCode

protected string|null $uniCode = null

Methods

__construct()

Constructor, create a minimal request Wallet object.

public __construct() : mixed

getAvatar()

Gets avatar

public getAvatar() : string|null

Filename of a wallet graphic (not fully qualified)

Return values
string|null —

the avatar

getCurrencies()

Gets currencies

public getCurrencies() : Currencies

Details of what currencies support payments for this wallet

Return values
Currencies —

the currencies

getDisplayName()

Gets display name

public getDisplayName() : string|null

Human readable display name for the wallet

Return values
string|null —

the display name

getImage()

Gets image

public getImage() : string|null

URL that displays wallet avatar image

Return values
string|null —

the image url

getInvoiceDefault()

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

getKey()

Gets A unique identifier for the wallet

public getKey() : string|null
Return values
string|null —

the key

getOffChainMode()

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

getPayPro()

Gets pay pro

public getPayPro() : bool|null

Whether or not the wallet supports ANY BitPay Payment Protocol options

Return values
bool|null —

the pay pro

getUniCode()

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

setAvatar()

Sets avatar

public setAvatar(string $avatar) : void

Filename of a wallet graphic (not fully qualified)

Parameters
$avatar : string

the avatar

setCurrencies()

Sets currencies

public setCurrencies(Currencies $currencies) : void

Details of what currencies support payments for this wallet

Parameters
$currencies : Currencies

the currencies

setDisplayName()

Sets display name

public setDisplayName(string $displayName) : void

Human readable display name for the wallet

Parameters
$displayName : string

the display name

setImage()

Sets image

public setImage(string $image) : void

URL that displays wallet avatar image

Parameters
$image : string

the image url

setInvoiceDefault()

public setInvoiceDefault(string|null $invoiceDefault) : void
Parameters
$invoiceDefault : string|null

setKey()

Sets A unique identifier for the wallet

public setKey(string $key) : void
Parameters
$key : string

the key

setOffChainMode()

public setOffChainMode(bool|null $offChainMode) : void
Parameters
$offChainMode : bool|null

setPayPro()

Sets pay pro

public setPayPro(bool $payPro) : void

Whether or not the wallet supports ANY BitPay Payment Protocol options

Parameters
$payPro : bool

the pay pro

setUniCode()

public setUniCode(string|null $uniCode) : void
Parameters
$uniCode : string|null

toArray()

Gets Wallet as array

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

Wallet as array


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results