PaymentFinder
in package
Uses
ValidatesQueryTrait
Tags
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() : PaymentList
- Finds all Payments matching the query criteria.
- findOne() : Payment|null
- Find one Payment
- 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 all Payments matching the query criteria.
public
find(Query $query) : PaymentList
TS docs reference for more detailed description
Query parameter must have the following value:
organization_id: <string> T-hub Organization UUID
Query parameter can have the following values:
batch_id: <string> e.g. bat_abc123
created_before: <int> UNIX timestamp
created_after: <int> UNIX timestamp
Parameters
- $query : Query
Tags
Return values
PaymentList —findOne()
Find one Payment
public
findOne(Query $query) : Payment|null
Query parameter must have the following values:
organization_id: <string> T-hub Organization UUID
id: <string> e.g. pay_4cc424b0bb36e8be089190454b33
Parameters
- $query : Query
Tags
Return values
Payment|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>