Interface BalanceTransactionsApiListBalanceTransactionsRequest

Request parameters for listBalanceTransactions operation in BalanceTransactionsApi.

Export

BalanceTransactionsApiListBalanceTransactionsRequest

Hierarchy

BalanceTransactionsApiListBalanceTransactionsRequest

Index

Properties

created_at_gte? created_at_lte? limit? offset? payout_id? source_id? tilled_account type?

Properties

`Optional` `Readonly` created_at_gte

created_at_gte?: string

Minimum `created_at` value to filter by (inclusive).

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` created_at_lte

created_at_lte?: string

Maximum `created_at` value to filter by (inclusive).

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` payout_id

payout_id?: string

Only returns transactions that were paid out on the specified payout ID.

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` source_id

source_id?: string

Only returns the original transaction.

Memberof

BalanceTransactionsApiListBalanceTransactions

`Readonly` tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

BalanceTransactionsApiListBalanceTransactions

`Optional` `Readonly` type

type?: ListBalanceTransactionsType

Only return transaction of the given type.

Memberof

BalanceTransactionsApiListBalanceTransactions

Generated using TypeDoc