Menu

## PayoutTransaction
in package

PayoutTransaction.php : 24

Contains the cryptocurrency transaction details for the executed payout.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

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

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

  REST API Payouts

### Table of Contents

#### Properties

$amount : float|null
$confirmations : int|null
$date : string|null
$txid : string|null

#### Methods

__construct() : mixed
getAmount() : float|null
  Gets Amount of cryptocurrency sent to the requested address.
getConfirmations() : int|null
  Gets the number of confirmations the transaction has received.
getDate() : string|null
  Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
getTxid() : string|null
  Gets Cryptocurrency transaction hash for the executed payout.
setAmount() : void
  Sets Amount of cryptocurrency sent to the requested address.
setConfirmations() : void
  Sets the number of confirmations the transaction has received.
setDate() : void
  Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.
setTxid() : void
  Sets Cryptocurrency transaction hash for the executed payout.
toArray() : array<string|int, mixed>
  Gets PayoutTransaction as array

### Properties

#### $amount

PayoutTransaction.php : 27
`protected float|null $amount = null`

#### $confirmations

PayoutTransaction.php : 29
`protected int|null $confirmations = null`

#### $date

PayoutTransaction.php : 28
`protected string|null $date = null`

#### $txid

PayoutTransaction.php : 26
`protected string|null $txid = null`

### Methods

#### __construct()

PayoutTransaction.php : 31
`public __construct() : mixed`

#### getAmount()

PayoutTransaction.php : 60

Gets Amount of cryptocurrency sent to the requested address.

`public getAmount() : float|null`

##### Return values

float|null —

the amount

#### getConfirmations()

PayoutTransaction.php : 102

Gets the number of confirmations the transaction has received.

`public getConfirmations() : int|null`

##### Return values

int|null

#### getDate()

PayoutTransaction.php : 81

Gets Date and time (UTC) when the cryptocurrency transaction is broadcasted.

`public getDate() : string|null`

ISO-8601 format yyyy-mm-ddThh:mm:ssZ.

##### Return values

string|null —

the date

#### getTxid()

PayoutTransaction.php : 40

Gets Cryptocurrency transaction hash for the executed payout.

`public getTxid() : string|null`

##### Return values

string|null —

the tax id

#### setAmount()

PayoutTransaction.php : 70

Sets Amount of cryptocurrency sent to the requested address.

`public setAmount(float|null $amount) : void`

##### Parameters

$amount : float|null

  the amount

#### setConfirmations()

PayoutTransaction.php : 112

Sets the number of confirmations the transaction has received.

`public setConfirmations(int|null $confirmations) : void`

##### Parameters

$confirmations : int|null

#### setDate()

PayoutTransaction.php : 92

Sets Date and time (UTC) when the cryptocurrency transaction is broadcasted.

`public setDate(string|null $date) : void`

ISO-8601 format yyyy-mm-ddThh:mm:ssZ.

##### Parameters

$date : string|null

  the date

#### setTxid()

PayoutTransaction.php : 50

Sets Cryptocurrency transaction hash for the executed payout.

`public setTxid(string|null $txid) : void`

##### Parameters

$txid : string|null

  the tax id

#### toArray()

PayoutTransaction.php : 122

Gets PayoutTransaction as array

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

##### Return values

array<string|int, mixed> —

PayoutTransaction as array

## Search results