PayoutInfo
in package
Object containing the settlement info provided by the Merchant in his BitPay account settings.
Tags
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
protected
string|null
$account
= null
$accountHolderAddress
protected
string|null
$accountHolderAddress
= null
$accountHolderAddress2
protected
string|null
$accountHolderAddress2
= null
$accountHolderCity
protected
string|null
$accountHolderCity
= null
$accountHolderCountry
protected
string|null
$accountHolderCountry
= null
$accountHolderName
protected
string|null
$accountHolderName
= null
$accountHolderPostalCode
protected
string|null
$accountHolderPostalCode
= null
$additionalInformation
protected
string|null
$additionalInformation
= null
$address
protected
string|null
$address
= null
$bank
protected
string|null
$bank
= null
$bankAddress
protected
string|null
$bankAddress
= null
$bankAddress2
protected
string|null
$bankAddress2
= null
$bankCountry
protected
string|null
$bankCountry
= null
$bankName
protected
string|null
$bankName
= null
$city
protected
string|null
$city
= null
$iban
protected
string|null
$iban
= null
$label
protected
string|null
$label
= null
$merchantEin
protected
string|null
$merchantEin
= null
$name
protected
string|null
$name
= null
$postal
protected
string|null
$postal
= null
$routing
protected
string|null
$routing
= null
$sort
protected
string|null
$sort
= null
$swift
protected
string|null
$swift
= null
$wire
protected
bool|null
$wire
= null
Methods
__construct()
public
__construct() : mixed
getAccount()
Gets Bank account number of the merchant
public
getAccount() : string|null
Return values
string|null —the bank account number
getAccountHolderAddress()
Gets Bank account holder address
public
getAccountHolderAddress() : string|null
Return values
string|null —the bank account holder address
getAccountHolderAddress2()
Gets Bank account holder address2
public
getAccountHolderAddress2() : string|null
Return values
string|null —the bank account holder address2
getAccountHolderCity()
Gets Bank account holder city
public
getAccountHolderCity() : string|null
Return values
string|null —the bank account holder city
getAccountHolderCountry()
Gets Bank account holder country
public
getAccountHolderCountry() : string|null
Return values
string|null —the bank account holder country
getAccountHolderName()
Gets Bank account holder name
public
getAccountHolderName() : string|null
Return values
string|null —the bank account holder name
getAccountHolderPostalCode()
Gets Bank account holder postal code
public
getAccountHolderPostalCode() : string|null
Return values
string|null —the bank account holder postal code
getAdditionalInformation()
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()
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()
Gets Name of the bank used by the merchant
public
getBank() : string|null
Return values
string|null —the bank
getBankAddress()
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()
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()
Gets Country where the merchant's bank account is located
public
getBankCountry() : string|null
Return values
string|null —the bank country
getBankName()
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()
Gets City of the merchant bank, field return if the settlement currency is
public
getCity() : string|null
Return values
string|null —the city
getIban()
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()
Gets label
public
getLabel() : string|null
As indicated by the merchant in his settlement settings
Return values
string|null —the label
getMerchantEin()
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()
Gets account holder name
public
getName() : string|null
Return values
string|null —the name
getPostal()
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()
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()
Gets sort
public
getSort() : string|null
used to pass country specific bank fields: BSB for AUD
Return values
string|nullgetSwift()
Gets SWIFT/BIC code of the merchant's bank.
public
getSwift() : string|null
Return values
string|null —the swift
getWire()
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()
Sets Bank account number of the merchant
public
setAccount(string $account) : void
Parameters
- $account : string
-
the bank account number
setAccountHolderAddress()
Sets Bank account holder address2
public
setAccountHolderAddress(string $accountHolderAddress) : void
Parameters
- $accountHolderAddress : string
-
the bank account holder address
setAccountHolderAddress2()
Sets Bank account holder address2
public
setAccountHolderAddress2(string $accountHolderAddress2) : void
Parameters
- $accountHolderAddress2 : string
-
the bank account holder address2
setAccountHolderCity()
Sets Bank account holder city
public
setAccountHolderCity(string $accountHolderCity) : void
Parameters
- $accountHolderCity : string
-
the bank account holder city
setAccountHolderCountry()
Sets Bank account holder country
public
setAccountHolderCountry(string $accountHolderCountry) : void
Parameters
- $accountHolderCountry : string
-
the bank account holder country
setAccountHolderName()
Sets Bank account holder name
public
setAccountHolderName(string $accountHolderName) : void
Parameters
- $accountHolderName : string
-
the bank account holder name
setAccountHolderPostalCode()
Sets Bank account holder postal code
public
setAccountHolderPostalCode(string $accountHolderPostalCode) : void
Parameters
- $accountHolderPostalCode : string
-
the bank account holder postal code
setAdditionalInformation()
Sets additional information
public
setAdditionalInformation(string $additionalInformation) : void
Parameters
- $additionalInformation : string
-
the additional information
setAddress()
Sets address
public
setAddress(string $address) : void
Parameters
- $address : string
-
the address
setBank()
Sets Name of the bank used by the merchant
public
setBank(string $bank) : void
Parameters
- $bank : string
-
the bank
setBankAddress()
Sets bank address
public
setBankAddress(string $bankAddress) : void
Parameters
- $bankAddress : string
-
the bank address
setBankAddress2()
Sets bank address2
public
setBankAddress2(string $bankAddress2) : void
Parameters
- $bankAddress2 : string
-
the bank address2
setBankCountry()
Sets Country where the merchant's bank account is located
public
setBankCountry(string $bankCountry) : void
Parameters
- $bankCountry : string
-
the bank country
setBankName()
Sets bank name
public
setBankName(string $bankName) : void
Parameters
- $bankName : string
-
the bank name
setCity()
Sets city of the merchant bank
public
setCity(string $city) : void
Parameters
- $city : string
-
the city
setIban()
Sets iban
public
setIban(string $iban) : void
Parameters
- $iban : string
-
the iban
setLabel()
Sets label
public
setLabel(string $label) : void
Parameters
- $label : string
-
the label
setMerchantEin()
Sets merchant ein
public
setMerchantEin(string $merchantEin) : void
Parameters
- $merchantEin : string
-
the merchant ein
setName()
Sets account holder name
public
setName(string $name) : void
Parameters
- $name : string
-
the name
setPostal()
Sets Postal code of the merchant bank
public
setPostal(string $postal) : void
Parameters
- $postal : string
-
the postal
setRouting()
Sets routing
public
setRouting(string $routing) : void
Parameters
- $routing : string
-
the routing
setSort()
Sets sort
public
setSort(string $sort) : void
Parameters
- $sort : string
-
the sort
setSwift()
Sets SWIFT/BIC code of the merchant's bank.
public
setSwift(string $swift) : void
Parameters
- $swift : string
-
the swift
setWire()
Sets wire
public
setWire(bool $wire) : void
Parameters
- $wire : bool
-
the wire
toArray()
Gets PayoutInfo as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —PayoutInfo as array