PayoutService.PayoutListRequest (gocardless-pro 3.7.0 API)

java.lang.Object
- com.gocardless.http.ListRequest<S,Payout>
- - com.gocardless.services.PayoutService.PayoutListRequest<S>

Enclosing class:

PayoutService
```
public static final class PayoutService.PayoutListRequest<S>
extends ListRequest<S,Payout>
```
Request class for PayoutService.list().
Returns a cursor-paginated list of your payouts.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PayoutService.PayoutListRequest.CreatedAt`
`static class`	`PayoutService.PayoutListRequest.Currency`
`static class`	`PayoutService.PayoutListRequest.PayoutType`
`static class`	`PayoutService.PayoutListRequest.Status`

Nested classes/interfaces inherited from class com.gocardless.http.ListRequest
ListRequest.ListRequestExecutor<S,T>

Method Summary

Methods
Modifier and Type	Method and Description
`PayoutService.PayoutListRequest<S>`	`withAfter(java.lang.String after)` Cursor pointing to the start of the desired set.
`PayoutService.PayoutListRequest<S>`	`withBefore(java.lang.String before)` Cursor pointing to the end of the desired set.
`PayoutService.PayoutListRequest<S>`	`withCreatedAt(PayoutService.PayoutListRequest.CreatedAt createdAt)`
`PayoutService.PayoutListRequest<S>`	`withCreatedAtGt(java.lang.String gt)` Limit to records created after the specified date-time.
`PayoutService.PayoutListRequest<S>`	`withCreatedAtGte(java.lang.String gte)` Limit to records created on or after the specified date-time.
`PayoutService.PayoutListRequest<S>`	`withCreatedAtLt(java.lang.String lt)` Limit to records created before the specified date-time.
`PayoutService.PayoutListRequest<S>`	`withCreatedAtLte(java.lang.String lte)` Limit to records created on or before the specified date-time.
`PayoutService.PayoutListRequest<S>`	`withCreditor(java.lang.String creditor)` Unique identifier, beginning with “CR”.
`PayoutService.PayoutListRequest<S>`	`withCreditorBankAccount(java.lang.String creditorBankAccount)` Unique identifier, beginning with “BA”.
`PayoutService.PayoutListRequest<S>`	`withCurrency(PayoutService.PayoutListRequest.Currency currency)` ISO 4217 currency code.
`PayoutService.PayoutListRequest<S>`	`withHeader(java.lang.String headerName, java.lang.String headerValue)`
`PayoutService.PayoutListRequest<S>`	`withLimit(java.lang.Integer limit)` Number of records to return.
`PayoutService.PayoutListRequest<S>`	`withPayoutType(PayoutService.PayoutListRequest.PayoutType payoutType)` Whether a payout contains merchant revenue or partner fees.
`PayoutService.PayoutListRequest<S>`	`withReference(java.lang.String reference)` Reference which appears on the creditor’s bank statement.
`PayoutService.PayoutListRequest<S>`	`withStatus(PayoutService.PayoutListRequest.Status status)` One of: `pending`: the payout has been created, but not yet sent to the banks `paid`: the payout has been sent to the banks

Methods inherited from class com.gocardless.http.ListRequest
execute, executeWrapped, iteratingExecutor, pagingExecutor

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withAfter

public PayoutService.PayoutListRequest<S> withAfter(java.lang.String after)

Cursor pointing to the start of the desired set.

withBefore

public PayoutService.PayoutListRequest<S> withBefore(java.lang.String before)

Cursor pointing to the end of the desired set.

withCreatedAt

public PayoutService.PayoutListRequest<S> withCreatedAt(PayoutService.PayoutListRequest.CreatedAt createdAt)

withCreatedAtGt

public PayoutService.PayoutListRequest<S> withCreatedAtGt(java.lang.String gt)

Limit to records created after the specified date-time.

withCreatedAtGte

public PayoutService.PayoutListRequest<S> withCreatedAtGte(java.lang.String gte)

Limit to records created on or after the specified date-time.

withCreatedAtLt

public PayoutService.PayoutListRequest<S> withCreatedAtLt(java.lang.String lt)

Limit to records created before the specified date-time.

withCreatedAtLte

public PayoutService.PayoutListRequest<S> withCreatedAtLte(java.lang.String lte)

Limit to records created on or before the specified date-time.

withCreditor

public PayoutService.PayoutListRequest<S> withCreditor(java.lang.String creditor)

Unique identifier, beginning with “CR”.

withCreditorBankAccount

public PayoutService.PayoutListRequest<S> withCreditorBankAccount(java.lang.String creditorBankAccount)

Unique identifier, beginning with “BA”.

withCurrency
```
public PayoutService.PayoutListRequest<S> withCurrency(PayoutService.PayoutListRequest.Currency currency)
```
ISO 4217 currency code. Currently “AUD”, “DKK”, “EUR”, “GBP”, “NZD” and “SEK” are supported.

withLimit

public PayoutService.PayoutListRequest<S> withLimit(java.lang.Integer limit)

Number of records to return.

withPayoutType

public PayoutService.PayoutListRequest<S> withPayoutType(PayoutService.PayoutListRequest.PayoutType payoutType)

Whether a payout contains merchant revenue or partner fees.

withReference

public PayoutService.PayoutListRequest<S> withReference(java.lang.String reference)

Reference which appears on the creditor’s bank statement.

withStatus
```
public PayoutService.PayoutListRequest<S> withStatus(PayoutService.PayoutListRequest.Status status)
```
One of:
- pending: the payout has been created, but not yet sent to the banks
- paid: the payout has been sent to the banks

withHeader

public PayoutService.PayoutListRequest<S> withHeader(java.lang.String headerName,
                                            java.lang.String headerValue)

Class PayoutService.PayoutListRequest<S>