RefundInfo
in package
For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
Tags
Table of Contents
Properties
- $amounts : array<string|int, mixed>|null
- $currency : string|null
- $supportRequest : string|null
Methods
- __construct() : mixed
- getAmounts() : array<string|int, mixed>|null
- Gets amounts
- getCurrency() : string|null
- Gets currency
- getSupportRequest() : string|null
- Gets support request
- setAmounts() : void
- Set amounts
- setCurrency() : void
- Sets currency
- setSupportRequest() : void
- Sets support request
- toArray() : array<string|int, mixed>
- Gets Refund info as array
Properties
$amounts
protected
array<string|int, mixed>|null
$amounts
= null
$currency
protected
string|null
$currency
= null
$supportRequest
protected
string|null
$supportRequest
= null
Methods
__construct()
public
__construct() : mixed
getAmounts()
Gets amounts
public
getAmounts() : array<string|int, mixed>|null
For a refunded invoice, this object will contain the crypto currency amount refunded by BitPay to the consumer (in the selected transactionCurrency) and the equivalent refunded amount from the invoice in the given currency (thus linked to the amount debited from the merchant account to cover the refund)
Return values
array<string|int, mixed>|null —the amounts
getCurrency()
Gets currency
public
getCurrency() : string|null
For a refunded invoice, this field will contain the base currency selected for the refund. Typically the same as the invoice currency.
Return values
string|null —the currency
getSupportRequest()
Gets support request
public
getSupportRequest() : string|null
For a refunded invoice, this field will contain the refund requestId once executed.
Return values
string|null —the support request
setAmounts()
Set amounts
public
setAmounts(array<string|int, mixed> $amounts) : void
For a refunded invoice, this object will contain the crypto currency amount refunded by BitPay to the consumer (in the selected transactionCurrency) and the equivalent refunded amount from the invoice in the given currency (thus linked to the amount debited from the merchant account to cover the refund)
Parameters
- $amounts : array<string|int, mixed>
-
the amounts
setCurrency()
Sets currency
public
setCurrency(string $currency) : void
For a refunded invoice, this field will contain the base currency selected for the refund. Typically the same as the invoice currency.
Parameters
- $currency : string
-
the currency
setSupportRequest()
Sets support request
public
setSupportRequest(string $supportRequest) : void
For a refunded invoice, this field will contain the refund requestId once executed.
Parameters
- $supportRequest : string
-
the support request
toArray()
Gets Refund info as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —refund info as array