public static final class MandateService.MandateListRequest<S> extends ListRequest<S,Mandate>
Request class for MandateService.list().
Returns a cursor-paginated list of your mandates.
| Modifier and Type | Class and Description |
|---|---|
static class |
MandateService.MandateListRequest.CreatedAt |
static class |
MandateService.MandateListRequest.Status |
ListRequest.ListRequestExecutor<S,T>| Modifier and Type | Method and Description |
|---|---|
MandateService.MandateListRequest<S> |
withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
|
MandateService.MandateListRequest<S> |
withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
|
MandateService.MandateListRequest<S> |
withCreatedAt(MandateService.MandateListRequest.CreatedAt createdAt) |
MandateService.MandateListRequest<S> |
withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
|
MandateService.MandateListRequest<S> |
withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
|
MandateService.MandateListRequest<S> |
withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
|
MandateService.MandateListRequest<S> |
withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
|
MandateService.MandateListRequest<S> |
withCreditor(java.lang.String creditor)
ID of a creditor.
|
MandateService.MandateListRequest<S> |
withCustomer(java.lang.String customer)
ID of a customer.
|
MandateService.MandateListRequest<S> |
withCustomerBankAccount(java.lang.String customerBankAccount)
ID of a customer bank account.
|
MandateService.MandateListRequest<S> |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
MandateService.MandateListRequest<S> |
withLimit(java.lang.Integer limit)
Number of records to return.
|
MandateService.MandateListRequest<S> |
withReference(java.lang.String reference)
Unique reference.
|
MandateService.MandateListRequest<S> |
withStatus(java.util.List<MandateService.MandateListRequest.Status> status)
At most four valid status values
|
MandateService.MandateListRequest<S> |
withStatus(MandateService.MandateListRequest.Status status)
At most four valid status values
|
execute, executeWrapped, iteratingExecutor, pagingExecutorpublic MandateService.MandateListRequest<S> withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
public MandateService.MandateListRequest<S> withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
public MandateService.MandateListRequest<S> withCreatedAt(MandateService.MandateListRequest.CreatedAt createdAt)
public MandateService.MandateListRequest<S> withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
public MandateService.MandateListRequest<S> withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
public MandateService.MandateListRequest<S> withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
public MandateService.MandateListRequest<S> withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
public MandateService.MandateListRequest<S> withCreditor(java.lang.String creditor)
ID of a creditor. If specified, this endpoint will return all mandates for the given creditor. Cannot be used in conjunction with customer or customer_bank_account
public MandateService.MandateListRequest<S> withCustomer(java.lang.String customer)
ID of a customer. If specified, this endpoint will return all mandates for the given customer. Cannot be used in conjunction with customer_bank_account or creditor
public MandateService.MandateListRequest<S> withCustomerBankAccount(java.lang.String customerBankAccount)
ID of a customer bank account. If specified, this endpoint will return all mandates for the given bank account. Cannot be used in conjunction with customer or creditor
public MandateService.MandateListRequest<S> withLimit(java.lang.Integer limit)
Number of records to return.
public MandateService.MandateListRequest<S> withReference(java.lang.String reference)
Unique reference. Different schemes have different length and character set requirements. GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank.
public MandateService.MandateListRequest<S> withStatus(java.util.List<MandateService.MandateListRequest.Status> status)
At most four valid status values
public MandateService.MandateListRequest<S> withStatus(MandateService.MandateListRequest.Status status)
At most four valid status values
public MandateService.MandateListRequest<S> withHeader(java.lang.String headerName, java.lang.String headerValue)