Interface PayoutsApiListPayoutsRequest

Request parameters for listPayouts operation in PayoutsApi.

Export

PayoutsApiListPayoutsRequest

Hierarchy

  • PayoutsApiListPayoutsRequest

Properties

created_at_gte?: string

Minimum `created_at` value to filter by (inclusive). Cannot be paired with paid_at_gte or paid_at_lte.

Memberof

PayoutsApiListPayouts

created_at_lte?: string

Maximum `created_at` value to filter by (inclusive). Cannot be paired with paid_at_gte or paid_at_lte.

Memberof

PayoutsApiListPayouts

include?: "transaction_count"

An array of optional include parameters, specifying extra properties to return. Currently for this endpoint only accepts 'transaction_count'. In the query parameters, this is specified as include=value1,value2,value3,etc.

Memberof

PayoutsApiListPayouts

include_connected_accounts?: boolean

Whether or not to include the results from any connected accounts.

Memberof

PayoutsApiListPayouts

limit?: number

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

Memberof

PayoutsApiListPayouts

offset?: number

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

Memberof

PayoutsApiListPayouts

paid_at_gte?: string

Minimum `paid_at` value to filter by (inclusive). Cannot be paired with created_at_gte or created_at_lte.

Memberof

PayoutsApiListPayouts

paid_at_lte?: string

Maximum `paid_at` value to filter by (inclusive). Cannot be paired with created_at_gte or created_at_lte.

Memberof

PayoutsApiListPayouts

q?: string

Supports searching by `payouts.id`, `payouts.amount`

Memberof

PayoutsApiListPayouts

Only return payouts that have the given status.

Memberof

PayoutsApiListPayouts

tilled_account: string

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

Memberof

PayoutsApiListPayouts

Generated using TypeDoc