Class: Filter

Filter

new Filter()

Specify a filter for refunds.
Source:

Extends

Methods

amount(amount, equality) → {Filter}

Add filtering by amount. e.g. "300" or ">300" or "<300"
Parameters:
Name Type Description
amount string | number the target amount
equality string | Filter.EQUALITY equality for the filter. If none is specified EQUAL is used.
Source:
Returns:
the same filter.
Type
Filter

client(client) → {Filter}

Add filtering by client
Parameters:
Name Type Description
client string | Client the client object or its id.
Source:
Returns:
the same filter.
Type
Filter

created_at(from, to) → {Filter}

Add filtering by created_at
Parameters:
Name Type Description
from number | Date the start date of the filter, either as Date or Unix-time number.
to number | Date the end date of the filter, either as Date or Unix-time number.
Source:
Returns:
the same filter.
Type
Filter

transaction(transaction) → {Filter}

Add filtering by transaction
Parameters:
Name Type Description
transaction string | Transaction the transaction object or its id.
Source:
Returns:
the same filter.
Type
Filter