Refund
class Refund extends Resource implements RefundInterface
Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.
Traits
Properties
| string | $id | A unique identifier for the resource. | from Resource |
| protected mixed | $response | A response from Stripe. | from Resource |
Methods
When you create a new refund, you must specify a charge on which to create it.
No description
Details
in Resource at line 29
string
getId()
Returns the unique identifier for this resource.
in Resource at line 39
mixed
getResponse()
Returns the raw Stripe response.
in Resource at line 47
protected void
setProperties()
Set the response data as properties on the class.
in ListAll at line 21
ListAll
listAll(array $arguments = [])
List all the resources.
This will list all of the resources from which this trait belongs to. It will then return itself, so you can method chain it, or reuse the same instantiation.
at line 43
RefundInterface
create(ChargeInterface $charge, array $arguments = [], string $key = null)
When you create a new refund, you must specify a charge on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.
You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.
Once entirely refunded, a charge can’t be refunded again. This method will throw an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.