Menu

## RefundInfo
in package

RefundInfo.php : 19

Object containing information about the refund.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

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

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

  Settlements

### Table of Contents

#### Properties

$amounts : array<string|int, mixed>|null
$currency : string|null
$refundRequestEid : string|null
$supportRequest : string|null

#### Methods

__construct() : mixed
getAmounts() : array<string|int, mixed>|null
  Gets amounts.
getCurrency() : string|null
  Gets currency.
getRefundRequestEid() : string
  Gets Refund Request Eid.
getSupportRequest() : string|null
  Gets support request.
setAmounts() : void
  Sets amounts.
setCurrency() : void
  Sets currency.
setRefundRequestEid() : void
  Sets Refund Request Eid.
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`

#### $refundRequestEid

RefundInfo.php : 24
`protected string|null $refundRequestEid = null`

#### $supportRequest

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

### Methods

#### __construct()

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

#### getAmounts()

RefundInfo.php : 87

Gets amounts.

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

This object will contain the crypto currency amount refunded by BitPay to the consumer

##### Return values

array<string|int, mixed>|null

#### getCurrency()

RefundInfo.php : 62

Gets currency.

`public getCurrency() : string|null`

ISO 4217 3-character currency code. This is the currency associated with the settlement. Supported settlement currencies are listed on Settlement Docs

##### Return values

string|null

#### getRefundRequestEid()

RefundInfo.php : 107

Gets Refund Request Eid.

`public getRefundRequestEid() : string`

##### Return values

string —

Request Eid

#### getSupportRequest()

RefundInfo.php : 37

Gets support request.

`public getSupportRequest() : string|null`

BitPay support request ID associated to the refund

##### Return values

string|null —

the support request

#### setAmounts()

RefundInfo.php : 97

Sets amounts.

`public setAmounts(array<string|int, mixed> $amounts) : void`

##### Parameters

$amounts : array<string|int, mixed>

#### setCurrency()

RefundInfo.php : 75

Sets currency.

`public setCurrency(string $currency) : void`

ISO 4217 3-character currency code. This is the currency associated with the settlement. Supported settlement currencies are listed on Settlement Docs

##### Parameters

$currency : string

  the currency

#### setRefundRequestEid()

RefundInfo.php : 117

Sets Refund Request Eid.

`public setRefundRequestEid(string|null $refundRequestEid) : void`

##### Parameters

$refundRequestEid : string|null

#### setSupportRequest()

RefundInfo.php : 49

Sets support request.

`public setSupportRequest(string $supportRequest) : void`

BitPay support request ID associated to the refund

##### Parameters

$supportRequest : string

  the support request

#### toArray()

RefundInfo.php : 127

Gets Refund info as array

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

##### Return values

array<string|int, mixed> —

refund info as array

## Search results