public static final class PaymentService.PaymentListRequest<S> extends ListRequest<S,Payment>
Request class for PaymentService.list().
Returns a cursor-paginated list of your payments.
| Modifier and Type | Class and Description |
|---|---|
static class |
PaymentService.PaymentListRequest.CreatedAt |
static class |
PaymentService.PaymentListRequest.Currency |
static class |
PaymentService.PaymentListRequest.Status |
ListRequest.ListRequestExecutor<S,T>| Modifier and Type | Method and Description |
|---|---|
PaymentService.PaymentListRequest<S> |
withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
|
PaymentService.PaymentListRequest<S> |
withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
|
PaymentService.PaymentListRequest<S> |
withCreatedAt(PaymentService.PaymentListRequest.CreatedAt createdAt) |
PaymentService.PaymentListRequest<S> |
withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
|
PaymentService.PaymentListRequest<S> |
withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
|
PaymentService.PaymentListRequest<S> |
withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
|
PaymentService.PaymentListRequest<S> |
withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
|
PaymentService.PaymentListRequest<S> |
withCreditor(java.lang.String creditor)
ID of a creditor to filter payments by.
|
PaymentService.PaymentListRequest<S> |
withCurrency(PaymentService.PaymentListRequest.Currency currency)
ISO 4217 currency code.
|
PaymentService.PaymentListRequest<S> |
withCustomer(java.lang.String customer)
ID of a customer to filter payments by.
|
PaymentService.PaymentListRequest<S> |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
PaymentService.PaymentListRequest<S> |
withLimit(java.lang.Integer limit)
Number of records to return.
|
PaymentService.PaymentListRequest<S> |
withMandate(java.lang.String mandate)
Unique identifier, beginning with “MD”.
|
PaymentService.PaymentListRequest<S> |
withStatus(PaymentService.PaymentListRequest.Status status)
One of:
pending_customer_approval: we’re waiting for the customer to approve this payment pending_submission: the payment has been created, but not yet submitted to the banks submitted: the payment has been submitted to the banks confirmed: the payment has been confirmed as collected paid_out: the payment has been included in a payout cancelled: the payment has been cancelled customer_approval_denied: the customer has denied approval for the payment. |
PaymentService.PaymentListRequest<S> |
withSubscription(java.lang.String subscription)
Unique identifier, beginning with “SB”.
|
execute, executeWrapped, iteratingExecutor, pagingExecutorpublic PaymentService.PaymentListRequest<S> withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
public PaymentService.PaymentListRequest<S> withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
public PaymentService.PaymentListRequest<S> withCreatedAt(PaymentService.PaymentListRequest.CreatedAt createdAt)
public PaymentService.PaymentListRequest<S> withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
public PaymentService.PaymentListRequest<S> withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
public PaymentService.PaymentListRequest<S> withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
public PaymentService.PaymentListRequest<S> withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
public PaymentService.PaymentListRequest<S> withCreditor(java.lang.String creditor)
ID of a creditor to filter payments by. If you pass this parameter, you cannot also pass customer.
public PaymentService.PaymentListRequest<S> withCurrency(PaymentService.PaymentListRequest.Currency currency)
ISO 4217 currency code. Currently “AUD”, “DKK”, “EUR”, “GBP”, “NZD” and “SEK” are supported.
public PaymentService.PaymentListRequest<S> withCustomer(java.lang.String customer)
ID of a customer to filter payments by. If you pass this parameter, you cannot also pass creditor.
public PaymentService.PaymentListRequest<S> withLimit(java.lang.Integer limit)
Number of records to return.
public PaymentService.PaymentListRequest<S> withMandate(java.lang.String mandate)
Unique identifier, beginning with “MD”.
public PaymentService.PaymentListRequest<S> withStatus(PaymentService.PaymentListRequest.Status status)
One of:
pending_customer_approval: we’re waiting for the customer to approve this paymentpending_submission: the payment has been created, but not yet submitted to the bankssubmitted: the payment has been submitted to the banksconfirmed: the payment has been confirmed as collectedpaid_out: the payment has been included in a payoutcancelled: the payment has been cancelledcustomer_approval_denied: the customer has denied approval for the payment. You should contact the customer directlyfailed: the payment failed to be processed. Note that payments can fail after being confirmed if the failure message is sent late by the banks.charged_back: the payment has been charged backpublic PaymentService.PaymentListRequest<S> withSubscription(java.lang.String subscription)
Unique identifier, beginning with “SB”.
public PaymentService.PaymentListRequest<S> withHeader(java.lang.String headerName, java.lang.String headerValue)