Refunds
in package
Refunds resource for managing order refunds.
Table of Contents
Methods
- __construct() : mixed
- cancel() : Refund
- Cancel a pending refund.
- create() : Refund
- Create a refund for paid order line items.
- lookup() : Refund
- Look up a refund by ID.
- page() : RefundPage
- Page through refunds.
Methods
__construct()
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
cancel()
Cancel a pending refund.
public
cancel(string $refundId[, string|null $idempotencyKey = null ]) : Refund
Parameters
- $refundId : string
- $idempotencyKey : string|null = null
Return values
Refundcreate()
Create a refund for paid order line items.
public
create(array<string|int, mixed> $payload[, string|null $idempotencyKey = null ]) : Refund
Parameters
- $payload : array<string|int, mixed>
- $idempotencyKey : string|null = null
Return values
Refundlookup()
Look up a refund by ID.
public
lookup(string $refundId) : Refund
Parameters
- $refundId : string
Return values
Refundpage()
Page through refunds.
public
page([array<string|int, mixed> $payload = [] ]) : RefundPage
Parameters
- $payload : array<string|int, mixed> = []