Menu

## RefundInfo
in package

RefundInfo.php : 19

For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

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

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

  REST API Invoices

### 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

RefundInfo.php : 23
`protected array<string|int, mixed>|null $amounts = null`

#### $currency

RefundInfo.php : 22
`protected string|null $currency = null`

#### $supportRequest

RefundInfo.php : 21
`protected string|null $supportRequest = null`

### Methods

#### __construct()

RefundInfo.php : 25
`public __construct() : mixed`

#### getAmounts()

RefundInfo.php : 89

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()

RefundInfo.php : 61

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()

RefundInfo.php : 36

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()

RefundInfo.php : 104

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()

RefundInfo.php : 74

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()

RefundInfo.php : 48

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()

RefundInfo.php : 114

Gets Refund info as array

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

##### Return values

array<string|int, mixed> —

refund info as array

## Search results