Menu

## PayoutInfo
in package

PayoutInfo.php : 19

Object containing the settlement info provided by the Merchant in his BitPay account settings.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

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

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

  Settlements

### Table of Contents

#### Properties

$account : string|null
$accountHolderAddress : string|null
$accountHolderAddress2 : string|null
$accountHolderCity : string|null
$accountHolderCountry : string|null
$accountHolderName : string|null
$accountHolderPostalCode : string|null
$additionalInformation : string|null
$address : string|null
$bank : string|null
$bankAddress : string|null
$bankAddress2 : string|null
$bankCountry : string|null
$bankName : string|null
$city : string|null
$iban : string|null
$label : string|null
$merchantEin : string|null
$name : string|null
$postal : string|null
$routing : string|null
$sort : string|null
$swift : string|null
$wire : bool|null

#### Methods

__construct() : mixed
getAccount() : string|null
  Gets Bank account number of the merchant
getAccountHolderAddress() : string|null
  Gets Bank account holder address
getAccountHolderAddress2() : string|null
  Gets Bank account holder address2
getAccountHolderCity() : string|null
  Gets Bank account holder city
getAccountHolderCountry() : string|null
  Gets Bank account holder country
getAccountHolderName() : string|null
  Gets Bank account holder name
getAccountHolderPostalCode() : string|null
  Gets Bank account holder postal code
getAdditionalInformation() : string|null
  Gets additional information
getAddress() : string|null
  Gets address
getBank() : string|null
  Gets Name of the bank used by the merchant
getBankAddress() : string|null
  Gets bank address
getBankAddress2() : string|null
  Gets bank address 2
getBankCountry() : string|null
  Gets Country where the merchant's bank account is located
getBankName() : string|null
  Gets bank name
getCity() : string|null
  Gets City of the merchant bank, field return if the settlement currency is
getIban() : string|null
  Gets iban
getLabel() : string|null
  Gets label
getMerchantEin() : string|null
  Gets merchant ein
getName() : string|null
  Gets account holder name
getPostal() : string|null
  Gets Postal code of the merchant bank, field return if the settlement currency is
getRouting() : string|null
  Gets routing
getSort() : string|null
  Gets sort
getSwift() : string|null
  Gets SWIFT/BIC code of the merchant's bank.
getWire() : bool|null
  Gets wire
setAccount() : void
  Sets Bank account number of the merchant
setAccountHolderAddress() : void
  Sets Bank account holder address2
setAccountHolderAddress2() : void
  Sets Bank account holder address2
setAccountHolderCity() : void
  Sets Bank account holder city
setAccountHolderCountry() : void
  Sets Bank account holder country
setAccountHolderName() : void
  Sets Bank account holder name
setAccountHolderPostalCode() : void
  Sets Bank account holder postal code
setAdditionalInformation() : void
  Sets additional information
setAddress() : void
  Sets address
setBank() : void
  Sets Name of the bank used by the merchant
setBankAddress() : void
  Sets bank address
setBankAddress2() : void
  Sets bank address2
setBankCountry() : void
  Sets Country where the merchant's bank account is located
setBankName() : void
  Sets bank name
setCity() : void
  Sets city of the merchant bank
setIban() : void
  Sets iban
setLabel() : void
  Sets label
setMerchantEin() : void
  Sets merchant ein
setName() : void
  Sets account holder name
setPostal() : void
  Sets Postal code of the merchant bank
setRouting() : void
  Sets routing
setSort() : void
  Sets sort
setSwift() : void
  Sets SWIFT/BIC code of the merchant's bank.
setWire() : void
  Sets wire
toArray() : array<string|int, mixed>
  Gets PayoutInfo as array

### Properties

#### $account

PayoutInfo.php : 30
`protected string|null $account = null`

#### $accountHolderAddress

PayoutInfo.php : 40
`protected string|null $accountHolderAddress = null`

#### $accountHolderAddress2

PayoutInfo.php : 41
`protected string|null $accountHolderAddress2 = null`

#### $accountHolderCity

PayoutInfo.php : 43
`protected string|null $accountHolderCity = null`

#### $accountHolderCountry

PayoutInfo.php : 44
`protected string|null $accountHolderCountry = null`

#### $accountHolderName

PayoutInfo.php : 39
`protected string|null $accountHolderName = null`

#### $accountHolderPostalCode

PayoutInfo.php : 42
`protected string|null $accountHolderPostalCode = null`

#### $additionalInformation

PayoutInfo.php : 38
`protected string|null $additionalInformation = null`

#### $address

PayoutInfo.php : 27
`protected string|null $address = null`

#### $bank

PayoutInfo.php : 25
`protected string|null $bank = null`

#### $bankAddress

PayoutInfo.php : 35
`protected string|null $bankAddress = null`

#### $bankAddress2

PayoutInfo.php : 36
`protected string|null $bankAddress2 = null`

#### $bankCountry

PayoutInfo.php : 24
`protected string|null $bankCountry = null`

#### $bankName

PayoutInfo.php : 34
`protected string|null $bankName = null`

#### $city

PayoutInfo.php : 28
`protected string|null $city = null`

#### $iban

PayoutInfo.php : 37
`protected string|null $iban = null`

#### $label

PayoutInfo.php : 23
`protected string|null $label = null`

#### $merchantEin

PayoutInfo.php : 31
`protected string|null $merchantEin = null`

#### $name

PayoutInfo.php : 21
`protected string|null $name = null`

#### $postal

PayoutInfo.php : 29
`protected string|null $postal = null`

#### $routing

PayoutInfo.php : 22
`protected string|null $routing = null`

#### $sort

PayoutInfo.php : 32
`protected string|null $sort = null`

#### $swift

PayoutInfo.php : 26
`protected string|null $swift = null`

#### $wire

PayoutInfo.php : 33
`protected bool|null $wire = null`

### Methods

#### __construct()

PayoutInfo.php : 46
`public __construct() : mixed`

#### getAccount()

PayoutInfo.php : 268

Gets Bank account number of the merchant

`public getAccount() : string|null`

##### Return values

string|null —

the bank account number

#### getAccountHolderAddress()

PayoutInfo.php : 466

Gets Bank account holder address

`public getAccountHolderAddress() : string|null`

##### Return values

string|null —

the bank account holder address

#### getAccountHolderAddress2()

PayoutInfo.php : 486

Gets Bank account holder address2

`public getAccountHolderAddress2() : string|null`

##### Return values

string|null —

the bank account holder address2

#### getAccountHolderCity()

PayoutInfo.php : 526

Gets Bank account holder city

`public getAccountHolderCity() : string|null`

##### Return values

string|null —

the bank account holder city

#### getAccountHolderCountry()

PayoutInfo.php : 546

Gets Bank account holder country

`public getAccountHolderCountry() : string|null`

##### Return values

string|null —

the bank account holder country

#### getAccountHolderName()

PayoutInfo.php : 446

Gets Bank account holder name

`public getAccountHolderName() : string|null`

##### Return values

string|null —

the bank account holder name

#### getAccountHolderPostalCode()

PayoutInfo.php : 506

Gets Bank account holder postal code

`public getAccountHolderPostalCode() : string|null`

##### Return values

string|null —

the bank account holder postal code

#### getAdditionalInformation()

PayoutInfo.php : 426

Gets additional information

`public getAdditionalInformation() : string|null`

When providing the settlement info via the dashboard, this field can be used by the merchant to provide additional information about the receiving bank. Field returned if "wire": true in the "payoutInfo" object

##### Return values

string|null —

the additional information

#### getAddress()

PayoutInfo.php : 208

Gets address

`public getAddress() : string|null`

This field is used to indicate the wallet address used for the settlement, if the settlement currency selected by the merchant is one of the supported crypto currency: Bitcoin (BTC), Bitcoin Cash (BCH), Dogecoin (DOGE), Ether (ETH), Gemini US Dollar (GUSD), Circle USD Coin (USDC), Paxos Standard USD (PAX), Binance USD (BUSD), Dai (DAI), Wrapped Bitcoin (WBTC), and Ripple (XRP). If the settlement currency used is AUD, GBP, NZD, MXN, ZAR - this field is used to indicate the address of the merchant's bank

##### Return values

string|null —

the address

#### getBank()

PayoutInfo.php : 161

Gets Name of the bank used by the merchant

`public getBank() : string|null`

##### Return values

string|null —

the bank

#### getBankAddress()

PayoutInfo.php : 357

Gets bank address

`public getBankAddress() : string|null`

Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object

##### Return values

string|null —

the bank address

#### getBankAddress2()

PayoutInfo.php : 379

Gets bank address 2

`public getBankAddress2() : string|null`

Address of the merchant's bank. Field returned if "wire": true in the "payoutInfo" object

##### Return values

string|null —

the bank address2

#### getBankCountry()

PayoutInfo.php : 121

Gets Country where the merchant's bank account is located

`public getBankCountry() : string|null`

##### Return values

string|null —

the bank country

#### getBankName()

PayoutInfo.php : 335

Gets bank name

`public getBankName() : string|null`

Name of the bank used by the merchant. Field returned if "wire": true in the "payoutInfo" object

##### Return values

string|null —

the bank name

#### getCity()

PayoutInfo.php : 228

Gets City of the merchant bank, field return if the settlement currency is

`public getCity() : string|null`

##### Return values

string|null —

the city

#### getIban()

PayoutInfo.php : 402

Gets iban

`public getIban() : string|null`

The merchant's bank account number, in the IBAN (International Bank Account Number) format. Field returned if "wire": true in the "payoutInfo" object

##### Return values

string|null —

the iban

#### getLabel()

PayoutInfo.php : 101

Gets label

`public getLabel() : string|null`

As indicated by the merchant in his settlement settings

##### Return values

string|null —

the label

#### getMerchantEin()

PayoutInfo.php : 79

Gets merchant ein

`public getMerchantEin() : string|null`

for merchants receiving USD settlements via local ACH, this field contains the merchant's EIN

##### Return values

string|null —

the merchant ein

#### getName()

PayoutInfo.php : 141

Gets account holder name

`public getName() : string|null`

##### Return values

string|null —

the name

#### getPostal()

PayoutInfo.php : 248

Gets Postal code of the merchant bank, field return if the settlement currency is

`public getPostal() : string|null`

##### Return values

string|null —

the postal

#### getRouting()

PayoutInfo.php : 57

Gets routing

`public getRouting() : string|null`

for merchants receiving USD settlements via local ACH, this field contains the ABA provided by the merchant

##### Return values

string|null —

the routing

#### getSort()

PayoutInfo.php : 290

Gets sort

`public getSort() : string|null`

used to pass country specific bank fields: BSB for AUD

##### Return values

string|null

#### getSwift()

PayoutInfo.php : 181

Gets SWIFT/BIC code of the merchant's bank.

`public getSwift() : string|null`

##### Return values

string|null —

the swift

#### getWire()

PayoutInfo.php : 313

Gets wire

`public getWire() : bool|null`

If set to true, this means BitPay will be settling the account using an international transfer via the SWIFT network instead of local settlement methods like ACH(United States) or SEPA (European Economic Area)

##### Return values

bool|null —

the wire

#### setAccount()

PayoutInfo.php : 278

Sets Bank account number of the merchant

`public setAccount(string $account) : void`

##### Parameters

$account : string

  the bank account number

#### setAccountHolderAddress()

PayoutInfo.php : 476

Sets Bank account holder address2

`public setAccountHolderAddress(string $accountHolderAddress) : void`

##### Parameters

$accountHolderAddress : string

  the bank account holder address

#### setAccountHolderAddress2()

PayoutInfo.php : 496

Sets Bank account holder address2

`public setAccountHolderAddress2(string $accountHolderAddress2) : void`

##### Parameters

$accountHolderAddress2 : string

  the bank account holder address2

#### setAccountHolderCity()

PayoutInfo.php : 536

Sets Bank account holder city

`public setAccountHolderCity(string $accountHolderCity) : void`

##### Parameters

$accountHolderCity : string

  the bank account holder city

#### setAccountHolderCountry()

PayoutInfo.php : 556

Sets Bank account holder country

`public setAccountHolderCountry(string $accountHolderCountry) : void`

##### Parameters

$accountHolderCountry : string

  the bank account holder country

#### setAccountHolderName()

PayoutInfo.php : 456

Sets Bank account holder name

`public setAccountHolderName(string $accountHolderName) : void`

##### Parameters

$accountHolderName : string

  the bank account holder name

#### setAccountHolderPostalCode()

PayoutInfo.php : 516

Sets Bank account holder postal code

`public setAccountHolderPostalCode(string $accountHolderPostalCode) : void`

##### Parameters

$accountHolderPostalCode : string

  the bank account holder postal code

#### setAdditionalInformation()

PayoutInfo.php : 436

Sets additional information

`public setAdditionalInformation(string $additionalInformation) : void`

##### Parameters

$additionalInformation : string

  the additional information

#### setAddress()

PayoutInfo.php : 218

Sets address

`public setAddress(string $address) : void`

##### Parameters

$address : string

  the address

#### setBank()

PayoutInfo.php : 171

Sets Name of the bank used by the merchant

`public setBank(string $bank) : void`

##### Parameters

$bank : string

  the bank

#### setBankAddress()

PayoutInfo.php : 367

Sets bank address

`public setBankAddress(string $bankAddress) : void`

##### Parameters

$bankAddress : string

  the bank address

#### setBankAddress2()

PayoutInfo.php : 389

Sets bank address2

`public setBankAddress2(string $bankAddress2) : void`

##### Parameters

$bankAddress2 : string

  the bank address2

#### setBankCountry()

PayoutInfo.php : 131

Sets Country where the merchant's bank account is located

`public setBankCountry(string $bankCountry) : void`

##### Parameters

$bankCountry : string

  the bank country

#### setBankName()

PayoutInfo.php : 345

Sets bank name

`public setBankName(string $bankName) : void`

##### Parameters

$bankName : string

  the bank name

#### setCity()

PayoutInfo.php : 238

Sets city of the merchant bank

`public setCity(string $city) : void`

##### Parameters

$city : string

  the city

#### setIban()

PayoutInfo.php : 413

Sets iban

`public setIban(string $iban) : void`

##### Parameters

$iban : string

  the iban

#### setLabel()

PayoutInfo.php : 111

Sets label

`public setLabel(string $label) : void`

##### Parameters

$label : string

  the label

#### setMerchantEin()

PayoutInfo.php : 89

Sets merchant ein

`public setMerchantEin(string $merchantEin) : void`

##### Parameters

$merchantEin : string

  the merchant ein

#### setName()

PayoutInfo.php : 151

Sets account holder name

`public setName(string $name) : void`

##### Parameters

$name : string

  the name

#### setPostal()

PayoutInfo.php : 258

Sets Postal code of the merchant bank

`public setPostal(string $postal) : void`

##### Parameters

$postal : string

  the postal

#### setRouting()

PayoutInfo.php : 67

Sets routing

`public setRouting(string $routing) : void`

##### Parameters

$routing : string

  the routing

#### setSort()

PayoutInfo.php : 300

Sets sort

`public setSort(string $sort) : void`

##### Parameters

$sort : string

  the sort

#### setSwift()

PayoutInfo.php : 191

Sets SWIFT/BIC code of the merchant's bank.

`public setSwift(string $swift) : void`

##### Parameters

$swift : string

  the swift

#### setWire()

PayoutInfo.php : 323

Sets wire

`public setWire(bool $wire) : void`

##### Parameters

$wire : bool

  the wire

#### toArray()

PayoutInfo.php : 566

Gets PayoutInfo as array

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

##### Return values

array<string|int, mixed> —

PayoutInfo as array

## Search results