RefundInfo
in package
Object containing information about the refund.
Tags
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
protected
array<string|int, mixed>|null
$amounts
= null
$currency
protected
string|null
$currency
= null
$refundRequestEid
protected
string|null
$refundRequestEid
= null
$supportRequest
protected
string|null
$supportRequest
= null
Methods
__construct()
public
__construct() : mixed
getAmounts()
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>|nullgetCurrency()
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|nullgetRefundRequestEid()
Gets Refund Request Eid.
public
getRefundRequestEid() : string
Return values
string —Request Eid
getSupportRequest()
Gets support request.
public
getSupportRequest() : string|null
BitPay support request ID associated to the refund
Return values
string|null —the support request
setAmounts()
Sets amounts.
public
setAmounts(array<string|int, mixed> $amounts) : void
Parameters
- $amounts : array<string|int, mixed>
setCurrency()
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()
Sets Refund Request Eid.
public
setRefundRequestEid(string|null $refundRequestEid) : void
Parameters
- $refundRequestEid : string|null
setSupportRequest()
Sets support request.
public
setSupportRequest(string $supportRequest) : void
BitPay support request ID associated to the refund
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