RefundFinder
in package
implements
FinderInterface
Uses
ValidatesQueryTrait
Tags
Interfaces, Classes, Traits and Enums
Table of Contents
- $client : Client
- __construct() : mixed
- buildQueryString() : array<string|int, mixed>
- Build an array of query params to be sent in the call
- find() : FinderListInterface
- Find refunds
- findOne() : Refund|null
- Find one refund
- validateQuery() : mixed
Properties
$client
protected
Client
$client
Tags
Methods
__construct()
public
__construct(Client $client) : mixed
Parameters
- $client : Client
Tags
Return values
mixed —buildQueryString()
Build an array of query params to be sent in the call
public
buildQueryString(Query $query) : array<string|int, mixed>
Parameters
- $query : Query
Tags
Return values
array<string|int, mixed> —find()
Find refunds
public
find(Query $query) : FinderListInterface
TS docs reference for more detailed descriptions
Query parameter must have the following value:
organization_id: <string> T-hub Organization UUID
Query parameter can have the following values:
deposit_id: <string> e.g. dep_343d42bcb694a3d2ecd1b380426a
status: <string> Options: pending, succeeded: alphanumeric - exact match (case-insensitive)
Parameters
- $query : Query
Tags
Return values
FinderListInterface —findOne()
Find one refund
public
findOne(Query $query) : Refund|null
Query parameter must have the following values:
id: <string> e.g. ref_681d5e30b023fb7776acfdcf92cf
organization_id: <string> T-hub Organization UUID
Parameters
- $query : Query
Tags
Return values
Refund|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>