InvoiceData
in package
Object containing relevant information from the paid invoice.
Tags
Table of Contents
Properties
- $currency : string|null
- $date : string|null
- $orderId : string|null
- $overPaidAmount : float|null
- $payoutPercentage : array<string|int, mixed>|null
- $price : float|null
- $refundInfo : RefundInfo|null
- $transactionCurrency : string|null
Methods
- __construct() : mixed
- getCurrency() : string|null
- Gets Invoice currency
- getDate() : string|null
- Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
- getOrderId() : string|null
- Gets Invoice orderId provided during invoice creation.
- getOverPaidAmount() : float|null
- Gets over paid amount
- getPayoutPercentage() : array<string|int, mixed>|null
- Gets The payout percentage defined by the merchant on his BitPay account settings
- getPrice() : float|null
- Gets Invoice price in the invoice original currency
- getRefundInfo() : RefundInfo|null
- Gets Object containing information about the refund executed for the invoice
- getTransactionCurrency() : string|null
- Gets Cryptocurrency selected by the consumer when paying the invoice.
- setCurrency() : void
- Sets Invoice currency
- setDate() : void
- Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
- setOrderId() : void
- Sets Invoice orderId provided during invoice creation.
- setOverPaidAmount() : void
- Sets over paid amount
- setPayoutPercentage() : void
- Sets The payout percentage defined by the merchant on his BitPay account settings
- setPrice() : void
- Sets Invoice price in the invoice original currency
- setRefundInfo() : void
- Sets Object containing information about the refund executed for the invoice
- setTransactionCurrency() : void
- Sets Cryptocurrency selected by the consumer when paying the invoice.
- toArray() : array<string|int, mixed>
- Gets InvoiceData as array
Properties
$currency
protected
string|null
$currency
= null
$date
protected
string|null
$date
= null
$orderId
protected
string|null
$orderId
= null
$overPaidAmount
protected
float|null
$overPaidAmount
= null
$payoutPercentage
protected
array<string|int, mixed>|null
$payoutPercentage
= null
$price
protected
float|null
$price
= null
$refundInfo
protected
RefundInfo|null
$refundInfo
= null
$transactionCurrency
protected
string|null
$transactionCurrency
= null
Methods
__construct()
public
__construct() : mixed
getCurrency()
Gets Invoice currency
public
getCurrency() : string|null
Return values
string|null —the Invoice currency
getDate()
Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
public
getDate() : string|null
Return values
string|null —the date
getOrderId()
Gets Invoice orderId provided during invoice creation.
public
getOrderId() : string|null
Return values
string|null —the order id
getOverPaidAmount()
Gets over paid amount
public
getOverPaidAmount() : float|null
Return values
float|null —the over paid amount
getPayoutPercentage()
Gets The payout percentage defined by the merchant on his BitPay account settings
public
getPayoutPercentage() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —the payout percentage
getPrice()
Gets Invoice price in the invoice original currency
public
getPrice() : float|null
Return values
float|null —the price
getRefundInfo()
Gets Object containing information about the refund executed for the invoice
public
getRefundInfo() : RefundInfo|null
Return values
RefundInfo|nullgetTransactionCurrency()
Gets Cryptocurrency selected by the consumer when paying the invoice.
public
getTransactionCurrency() : string|null
Return values
string|null —the transaction currency
setCurrency()
Sets Invoice currency
public
setCurrency(string $currency) : void
Parameters
- $currency : string
-
the Invoice currency
setDate()
Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
public
setDate(string $date) : void
Parameters
- $date : string
-
the date
setOrderId()
Sets Invoice orderId provided during invoice creation.
public
setOrderId(string $orderId) : void
Parameters
- $orderId : string
-
the order id
setOverPaidAmount()
Sets over paid amount
public
setOverPaidAmount(float $overPaidAmount) : void
Parameters
- $overPaidAmount : float
-
the over paid amount
setPayoutPercentage()
Sets The payout percentage defined by the merchant on his BitPay account settings
public
setPayoutPercentage(array<string|int, mixed> $payoutPercentage) : void
Parameters
- $payoutPercentage : array<string|int, mixed>
-
the payout percentage
setPrice()
Sets Invoice price in the invoice original currency
public
setPrice(float $price) : void
Parameters
- $price : float
-
the price
setRefundInfo()
Sets Object containing information about the refund executed for the invoice
public
setRefundInfo(RefundInfo $refundInfo) : void
Parameters
- $refundInfo : RefundInfo
setTransactionCurrency()
Sets Cryptocurrency selected by the consumer when paying the invoice.
public
setTransactionCurrency(string $transactionCurrency) : void
Parameters
- $transactionCurrency : string
-
the transaction currency
toArray()
Gets InvoiceData as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —InvoiceData as array