PaymentBatchFinder
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
- Finds payment batches matching the criteria.
- findOne() : PaymentBatch|null
- Finds one payment batch matched by ID.
- validateQuery() : mixed
Properties
$client
private
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()
Finds payment batches matching the criteria.
public
find(Query $query) : FinderListInterface
TS docs reference for more detailed descriptions: https://api.tithelyqa.com/doc/organization#tag/Batches/operation/Retrieve%20a%20list%20of%20Batches
Query parameter must have the following value:
organization_id: <string> T-hub Organization UUID
Query parameter can have the following values:
created_before: <int> unix timestamp
created_after: <int> unix timestamp
page: <int>
page_size: <int>
order_by: <string>
Parameters
- $query : Query
Tags
Return values
FinderListInterface —findOne()
Finds one payment batch matched by ID.
public
findOne(Query $query) : PaymentBatch|null
Query parameter must have the following values:
organization_id: <string> T-hub Organization UUID
id: <string> e.g. bat_343d42bcb694a3d2ecd1b380426a
Parameters
- $query : Query
Tags
Return values
PaymentBatch|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>