Index (gocardless-pro 3.7.0 API)

A B C D E G H I L M N P R S T U V W

A

all() - Method in class com.gocardless.services.CreditorBankAccountService
all() - Method in class com.gocardless.services.CreditorService
all() - Method in class com.gocardless.services.CustomerBankAccountService
all() - Method in class com.gocardless.services.CustomerService
all() - Method in class com.gocardless.services.EventService
all() - Method in class com.gocardless.services.MandateImportEntryService
all() - Method in class com.gocardless.services.MandateService
all() - Method in class com.gocardless.services.PaymentService
all() - Method in class com.gocardless.services.PayoutItemService
all() - Method in class com.gocardless.services.PayoutService
all() - Method in class com.gocardless.services.RefundService
all() - Method in class com.gocardless.services.SubscriptionService
ApiError - Class in com.gocardless.errors: Representation of an individual error handling an API request.
ApiErrorResponse - Class in com.gocardless.errors
ApiResponse<T> - Class in com.gocardless.http: Base class for API responses.
ApiResponse(T, int, Map<String, List<String>>) - Constructor for class com.gocardless.http.ApiResponse

B

BankDetailsLookup - Class in com.gocardless.resources: Represents a bank details lookup resource returned from the API.
BankDetailsLookup.AvailableDebitScheme - Enum in com.gocardless.resources
bankDetailsLookups() - Method in class com.gocardless.GoCardlessClient: A service class for working with bank details lookup resources.
BankDetailsLookupService - Class in com.gocardless.services: Service class for working with bank details lookup resources.
BankDetailsLookupService(HttpClient) - Constructor for class com.gocardless.services.BankDetailsLookupService: Constructor.
BankDetailsLookupService.BankDetailsLookupCreateRequest - Class in com.gocardless.services: Request class for BankDetailsLookupService.create().
build() - Method in class com.gocardless.GoCardlessClient.Builder: Builds a configured instance of the GoCardlessClient

C

cancel(String) - Method in class com.gocardless.services.MandateImportService: Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless.
cancel(String) - Method in class com.gocardless.services.MandateService: Immediately cancels a mandate and all associated cancellable payments.
cancel(String) - Method in class com.gocardless.services.PaymentService: Cancels the payment if it has not already been submitted to the banks.
cancel(String) - Method in class com.gocardless.services.SubscriptionService: Immediately cancels a subscription; no more payments will be created under it.
com.gocardless - package com.gocardless: Java client library for the GoCardless API.
com.gocardless.errors - package com.gocardless.errors: Representations of API errors.
com.gocardless.http - package com.gocardless.http: Classes for making HTTP requests and handling responses.
com.gocardless.resources - package com.gocardless.resources: Representations of resources returned from the API.
com.gocardless.services - package com.gocardless.services: Services for interacting with API resources.
complete(String) - Method in class com.gocardless.services.RedirectFlowService: This creates a customer, customer bank account, and mandate using the details supplied by your customer and returns the ID of the created mandate.
create() - Method in class com.gocardless.services.BankDetailsLookupService: Performs a bank details lookup.
create() - Method in class com.gocardless.services.CreditorBankAccountService: Creates a new creditor bank account object.
create() - Method in class com.gocardless.services.CreditorService: Creates a new creditor.
create() - Method in class com.gocardless.services.CustomerBankAccountService: Creates a new customer bank account object.
create() - Method in class com.gocardless.services.CustomerService: Creates a new customer object.
create() - Method in class com.gocardless.services.MandateImportEntryService: For an existing mandate import, this endpoint can be used to add individual mandates to be imported into GoCardless.
create() - Method in class com.gocardless.services.MandateImportService: Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process.
create() - Method in class com.gocardless.services.MandatePdfService: Generates a PDF mandate and returns its temporary URL.
create() - Method in class com.gocardless.services.MandateService: Creates a new mandate object.
create() - Method in class com.gocardless.services.PaymentService: Creates a new payment object.
create() - Method in class com.gocardless.services.RedirectFlowService: Creates a redirect flow object which can then be used to redirect your customer to the GoCardless hosted payment pages.
create() - Method in class com.gocardless.services.RefundService: Creates a new refund object.
create() - Method in class com.gocardless.services.SubscriptionService: Creates a new subscription object
Creditor - Class in com.gocardless.resources: Represents a creditor resource returned from the API.
Creditor.Links - Class in com.gocardless.resources
Creditor.SchemeIdentifier - Class in com.gocardless.resources
Creditor.SchemeIdentifier.Currency - Enum in com.gocardless.resources
Creditor.SchemeIdentifier.Scheme - Enum in com.gocardless.resources
Creditor.VerificationStatus - Enum in com.gocardless.resources
CreditorBankAccount - Class in com.gocardless.resources: Represents a creditor bank account resource returned from the API.
CreditorBankAccount.Links - Class in com.gocardless.resources
creditorBankAccounts() - Method in class com.gocardless.GoCardlessClient: A service class for working with creditor bank account resources.
CreditorBankAccountService - Class in com.gocardless.services: Service class for working with creditor bank account resources.
CreditorBankAccountService(HttpClient) - Constructor for class com.gocardless.services.CreditorBankAccountService: Constructor.
CreditorBankAccountService.CreditorBankAccountCreateRequest - Class in com.gocardless.services: Request class for CreditorBankAccountService.create().
CreditorBankAccountService.CreditorBankAccountCreateRequest.Links - Class in com.gocardless.services
CreditorBankAccountService.CreditorBankAccountCreateRequest.Links() - Constructor for class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest.Links
CreditorBankAccountService.CreditorBankAccountDisableRequest - Class in com.gocardless.services: Request class for CreditorBankAccountService.disable(java.lang.String).
CreditorBankAccountService.CreditorBankAccountGetRequest - Class in com.gocardless.services: Request class for CreditorBankAccountService.get(java.lang.String).
CreditorBankAccountService.CreditorBankAccountListRequest<S> - Class in com.gocardless.services: Request class for CreditorBankAccountService.list().
CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt - Class in com.gocardless.services
CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt() - Constructor for class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt
creditors() - Method in class com.gocardless.GoCardlessClient: A service class for working with creditor resources.
CreditorService - Class in com.gocardless.services: Service class for working with creditor resources.
CreditorService(HttpClient) - Constructor for class com.gocardless.services.CreditorService: Constructor.
CreditorService.CreditorCreateRequest - Class in com.gocardless.services: Request class for CreditorService.create().
CreditorService.CreditorGetRequest - Class in com.gocardless.services: Request class for CreditorService.get(java.lang.String).
CreditorService.CreditorListRequest<S> - Class in com.gocardless.services: Request class for CreditorService.list().
CreditorService.CreditorListRequest.CreatedAt - Class in com.gocardless.services
CreditorService.CreditorListRequest.CreatedAt() - Constructor for class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt
CreditorService.CreditorUpdateRequest - Class in com.gocardless.services: Request class for CreditorService.update(java.lang.String).
CreditorService.CreditorUpdateRequest.Links - Class in com.gocardless.services
CreditorService.CreditorUpdateRequest.Links() - Constructor for class com.gocardless.services.CreditorService.CreditorUpdateRequest.Links
Customer - Class in com.gocardless.resources: Represents a customer resource returned from the API.
CustomerBankAccount - Class in com.gocardless.resources: Represents a customer bank account resource returned from the API.
CustomerBankAccount.Links - Class in com.gocardless.resources
customerBankAccounts() - Method in class com.gocardless.GoCardlessClient: A service class for working with customer bank account resources.
CustomerBankAccountService - Class in com.gocardless.services: Service class for working with customer bank account resources.
CustomerBankAccountService(HttpClient) - Constructor for class com.gocardless.services.CustomerBankAccountService: Constructor.
CustomerBankAccountService.CustomerBankAccountCreateRequest - Class in com.gocardless.services: Request class for CustomerBankAccountService.create().
CustomerBankAccountService.CustomerBankAccountCreateRequest.Links - Class in com.gocardless.services
CustomerBankAccountService.CustomerBankAccountCreateRequest.Links() - Constructor for class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest.Links
CustomerBankAccountService.CustomerBankAccountDisableRequest - Class in com.gocardless.services: Request class for CustomerBankAccountService.disable(java.lang.String).
CustomerBankAccountService.CustomerBankAccountGetRequest - Class in com.gocardless.services: Request class for CustomerBankAccountService.get(java.lang.String).
CustomerBankAccountService.CustomerBankAccountListRequest<S> - Class in com.gocardless.services: Request class for CustomerBankAccountService.list().
CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt - Class in com.gocardless.services
CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt() - Constructor for class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt
CustomerBankAccountService.CustomerBankAccountUpdateRequest - Class in com.gocardless.services: Request class for CustomerBankAccountService.update(java.lang.String).
CustomerNotification - Class in com.gocardless.resources: Represents a customer notification resource returned from the API.
CustomerNotification.ActionTaken - Enum in com.gocardless.resources
CustomerNotification.Links - Class in com.gocardless.resources
CustomerNotification.Type - Enum in com.gocardless.resources
customerNotifications() - Method in class com.gocardless.GoCardlessClient: A service class for working with customer notification resources.
CustomerNotificationService - Class in com.gocardless.services: Service class for working with customer notification resources.
CustomerNotificationService(HttpClient) - Constructor for class com.gocardless.services.CustomerNotificationService: Constructor.
CustomerNotificationService.CustomerNotificationHandleRequest - Class in com.gocardless.services: Request class for CustomerNotificationService.handle(java.lang.String).
customers() - Method in class com.gocardless.GoCardlessClient: A service class for working with customer resources.
CustomerService - Class in com.gocardless.services: Service class for working with customer resources.
CustomerService(HttpClient) - Constructor for class com.gocardless.services.CustomerService: Constructor.
CustomerService.CustomerCreateRequest - Class in com.gocardless.services: Request class for CustomerService.create().
CustomerService.CustomerGetRequest - Class in com.gocardless.services: Request class for CustomerService.get(java.lang.String).
CustomerService.CustomerListRequest<S> - Class in com.gocardless.services: Request class for CustomerService.list().
CustomerService.CustomerListRequest.CreatedAt - Class in com.gocardless.services
CustomerService.CustomerListRequest.CreatedAt() - Constructor for class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt
CustomerService.CustomerUpdateRequest - Class in com.gocardless.services: Request class for CustomerService.update(java.lang.String).

D

disable(String) - Method in class com.gocardless.services.CreditorBankAccountService: Immediately disables the bank account, no money can be paid out to a disabled account.
disable(String) - Method in class com.gocardless.services.CustomerBankAccountService: Immediately cancels all associated mandates and cancellable payments.

E

ErrorType - Enum in com.gocardless.errors: Types of error that can be returned by the API.
Event - Class in com.gocardless.resources: Represents a event resource returned from the API.
Event.CustomerNotification - Class in com.gocardless.resources
Event.CustomerNotification.Type - Enum in com.gocardless.resources
Event.Details - Class in com.gocardless.resources
Event.Details.Origin - Enum in com.gocardless.resources
Event.Details.Scheme - Enum in com.gocardless.resources
Event.Links - Class in com.gocardless.resources
Event.ResourceType - Enum in com.gocardless.resources
events() - Method in class com.gocardless.GoCardlessClient: A service class for working with event resources.
EventService - Class in com.gocardless.services: Service class for working with event resources.
EventService(HttpClient) - Constructor for class com.gocardless.services.EventService: Constructor.
EventService.EventGetRequest - Class in com.gocardless.services: Request class for EventService.get(java.lang.String).
EventService.EventListRequest<S> - Class in com.gocardless.services: Request class for EventService.list().
EventService.EventListRequest.CreatedAt - Class in com.gocardless.services
EventService.EventListRequest.CreatedAt() - Constructor for class com.gocardless.services.EventService.EventListRequest.CreatedAt
EventService.EventListRequest.Include - Enum in com.gocardless.services
EventService.EventListRequest.ResourceType - Enum in com.gocardless.services
execute() - Method in class com.gocardless.http.GetRequest: Executes this request.
execute() - Method in class com.gocardless.http.IdempotentPostRequest: Executes this request.
execute() - Method in class com.gocardless.http.ListRequest: Executes this request.
execute(ListRequest<S, T>, HttpClient) - Method in interface com.gocardless.http.ListRequest.ListRequestExecutor
execute() - Method in class com.gocardless.http.PostRequest: Executes this request.
execute() - Method in class com.gocardless.http.PutRequest: Executes this request.
executeWrapped() - Method in class com.gocardless.http.GetRequest: Executes this request.
executeWrapped() - Method in class com.gocardless.http.ListRequest: Executes this request.
executeWrapped(ListRequest<S, T>, HttpClient) - Method in interface com.gocardless.http.ListRequest.ListRequestExecutor
executeWrapped() - Method in class com.gocardless.http.PostRequest: Executes this request.
executeWrapped() - Method in class com.gocardless.http.PutRequest: Executes this request.

G

get(String) - Method in class com.gocardless.services.CreditorBankAccountService: Retrieves the details of an existing creditor bank account.
get(String) - Method in class com.gocardless.services.CreditorService: Retrieves the details of an existing creditor.
get(String) - Method in class com.gocardless.services.CustomerBankAccountService: Retrieves the details of an existing bank account.
get(String) - Method in class com.gocardless.services.CustomerService: Retrieves the details of an existing customer.
get(String) - Method in class com.gocardless.services.EventService: Retrieves the details of a single event.
get(String) - Method in class com.gocardless.services.MandateImportService: Returns a single mandate import.
get(String) - Method in class com.gocardless.services.MandateService: Retrieves the details of an existing mandate.
get(String) - Method in class com.gocardless.services.PaymentService: Retrieves the details of a single existing payment.
get(String) - Method in class com.gocardless.services.PayoutService: Retrieves the details of a single payout.
get(String) - Method in class com.gocardless.services.RedirectFlowService: Returns all details about a single redirect flow
get(String) - Method in class com.gocardless.services.RefundService: Retrieves all details for a single refund
get(String) - Method in class com.gocardless.services.SubscriptionService: Retrieves the details of a single subscription.
getAccountHolderName() - Method in class com.gocardless.resources.CreditorBankAccount: Name of the account holder, as known by the bank.
getAccountHolderName() - Method in class com.gocardless.resources.CustomerBankAccount: Name of the account holder, as known by the bank.
getAccountNumberEnding() - Method in class com.gocardless.resources.CreditorBankAccount: Last two digits of account number.
getAccountNumberEnding() - Method in class com.gocardless.resources.CustomerBankAccount: Last two digits of account number.
getAction() - Method in class com.gocardless.resources.Event: What has happened to the resource.
getActionTaken() - Method in class com.gocardless.resources.CustomerNotification: The action that was taken on the notification.
getActionTakenAt() - Method in class com.gocardless.resources.CustomerNotification: Fixed timestamp, recording when this action was taken.
getActionTakenBy() - Method in class com.gocardless.resources.CustomerNotification: A string identifying the integrator who was able to handle this notification.
getAddressLine1() - Method in class com.gocardless.resources.Creditor: The first line of the creditor’s address.
getAddressLine1() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The first line of the support address.
getAddressLine1() - Method in class com.gocardless.resources.Customer: The first line of the customer’s address.
getAddressLine2() - Method in class com.gocardless.resources.Creditor: The second line of the creditor’s address.
getAddressLine2() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The second line of the support address.
getAddressLine2() - Method in class com.gocardless.resources.Customer: The second line of the customer’s address.
getAddressLine3() - Method in class com.gocardless.resources.Creditor: The third line of the creditor’s address.
getAddressLine3() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The third line of the support address.
getAddressLine3() - Method in class com.gocardless.resources.Customer: The third line of the customer’s address.
getAfter() - Method in class com.gocardless.http.ListResponse: Returns a cursor that can be used to get the page after this one.
getAmount() - Method in class com.gocardless.resources.Payment: Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
getAmount() - Method in class com.gocardless.resources.Payout: Amount in pence or cents.
getAmount() - Method in class com.gocardless.resources.PayoutItem: The positive (credit) or negative (debit) value of the item, in fractional currency; either pence (GBP), cents (AUD/EUR), or öre (SEK), to one decimal place.
getAmount() - Method in class com.gocardless.resources.Refund: Amount in pence/cents/öre.
getAmount() - Method in class com.gocardless.resources.Subscription: Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
getAmount() - Method in class com.gocardless.resources.Subscription.UpcomingPayment: The amount of this payment, in pence.
getAmountRefunded() - Method in class com.gocardless.resources.Payment: Amount refunded in pence/cents/öre/øre.
getAppFee() - Method in class com.gocardless.resources.Subscription: The amount to be deducted from each payment as an app fee, to be paid to the partner integration which created the subscription, in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
getArrivalDate() - Method in class com.gocardless.resources.Payout: Date the payout is due to arrive in the creditor’s bank account.
getAvailableDebitSchemes() - Method in class com.gocardless.resources.BankDetailsLookup: Array of schemes supported for this bank account.
getBankName() - Method in class com.gocardless.resources.BankDetailsLookup: The name of the bank with which the account is held (if available).
getBankName() - Method in class com.gocardless.resources.CreditorBankAccount: Name of bank, taken from the bank details.
getBankName() - Method in class com.gocardless.resources.CustomerBankAccount: Name of bank, taken from the bank details.
getBefore() - Method in class com.gocardless.http.ListResponse: Returns a cursor that can be used to get the page before this one.
getBic() - Method in class com.gocardless.resources.BankDetailsLookup: ISO 9362 SWIFT BIC of the bank with which the account is held.
getCanCreateRefunds() - Method in class com.gocardless.resources.Creditor: Boolean indicating whether the creditor is permitted to create refunds
getCanSpecifyMandateReference() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: Whether a custom reference can be submitted for mandates using this scheme identifier.
getCause() - Method in class com.gocardless.resources.Event.Details: What triggered the event.
getChargeDate() - Method in class com.gocardless.resources.Payment: A future date on which the payment should be collected.
getChargeDate() - Method in class com.gocardless.resources.Subscription.UpcomingPayment: The date on which this payment will be charged.
getCity() - Method in class com.gocardless.resources.Creditor: The city of the creditor’s address.
getCity() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The city of the support address.
getCity() - Method in class com.gocardless.resources.Customer: The city of the customer’s address.
getCode() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns the HTTP status code.
getCompanyName() - Method in class com.gocardless.resources.Customer: Customer’s company name.
getConfirmationUrl() - Method in class com.gocardless.resources.RedirectFlow: The URL of a confirmation page, which you may optionally redirect the customer to rather than use your own page, that confirms in their chosen language that their Direct Debit has been set up successfully.
getCountryCode() - Method in class com.gocardless.resources.Creditor: ISO 3166-1 alpha-2 code.
getCountryCode() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The support ISO 3166-1 country code.
getCountryCode() - Method in class com.gocardless.resources.CreditorBankAccount: ISO 3166-1 alpha-2 code.
getCountryCode() - Method in class com.gocardless.resources.Customer: ISO 3166-1 alpha-2 code.
getCountryCode() - Method in class com.gocardless.resources.CustomerBankAccount: ISO 3166-1 alpha-2 code.
getCreatedAt() - Method in class com.gocardless.resources.Creditor: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.CreditorBankAccount: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Customer: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.CustomerBankAccount: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Event: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Mandate: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.MandateImport: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.MandateImportEntry: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Payment: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Payout: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.RedirectFlow: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Refund: Fixed timestamp, recording when this resource was created.
getCreatedAt() - Method in class com.gocardless.resources.Subscription: Fixed timestamp, recording when this resource was created.
getCreditor() - Method in class com.gocardless.resources.CreditorBankAccount.Links: ID of the creditor that owns this bank account.
getCreditor() - Method in class com.gocardless.resources.Mandate.Links: ID of the associated creditor.
getCreditor() - Method in class com.gocardless.resources.Payment.Links: ID of creditor to which the collected payment will be sent.
getCreditor() - Method in class com.gocardless.resources.Payout.Links: ID of creditor who will receive this payout, i.e.
getCreditor() - Method in class com.gocardless.resources.RedirectFlow.Links: The creditor for whom the mandate will be created.
getCreditorBankAccount() - Method in class com.gocardless.resources.Payout.Links: ID of bank account which this will be sent to.
getCurrency() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The currency of the scheme identifier.
getCurrency() - Method in class com.gocardless.resources.CreditorBankAccount: ISO 4217 currency code, defaults to national currency of country_code.
getCurrency() - Method in class com.gocardless.resources.CustomerBankAccount: ISO 4217 currency code, defaults to national currency of country_code.
getCurrency() - Method in class com.gocardless.resources.Payment: ISO 4217 currency code.
getCurrency() - Method in class com.gocardless.resources.Payout: ISO 4217 currency code.
getCurrency() - Method in class com.gocardless.resources.Refund: ISO 4217 currency code.
getCurrency() - Method in class com.gocardless.resources.Subscription: ISO 4217 currency code.
getCustomer() - Method in class com.gocardless.resources.CustomerBankAccount.Links: ID of the customer that owns this bank account.
getCustomer() - Method in class com.gocardless.resources.CustomerNotification.Links: The customer who should be contacted with this notification.
getCustomer() - Method in class com.gocardless.resources.Mandate.Links: ID of the associated customer
getCustomer() - Method in class com.gocardless.resources.MandateImportEntry.Links: The ID of the customer which was created when the mandate import was processed.
getCustomer() - Method in class com.gocardless.resources.RedirectFlow.Links: ID of customer created by this redirect flow.
**Note**: this property will not be present until the redirect flow has been successfully completed.
getCustomerBankAccount() - Method in class com.gocardless.resources.Mandate.Links: ID of the associated customer bank account which the mandate is created and submits payments against.
getCustomerBankAccount() - Method in class com.gocardless.resources.MandateImportEntry.Links: The ID of the customer bank account which was created when the mandate import was processed.
getCustomerBankAccount() - Method in class com.gocardless.resources.RedirectFlow.Links: ID of customer bank account created by this redirect flow.
**Note**: this property will not be present until the redirect flow has been successfully completed.
getCustomerNotifications() - Method in class com.gocardless.resources.Event: Present only in webhooks when an integrator is authorised to send their own notifications.
getDanishIdentityNumber() - Method in class com.gocardless.resources.Customer: For Danish customers only.
getDayOfMonth() - Method in class com.gocardless.resources.Subscription: As per RFC 2445.
getDeadline() - Method in class com.gocardless.resources.Event.CustomerNotification: Time after which GoCardless will send the notification by email.
getDeductedFees() - Method in class com.gocardless.resources.Payout: Fees that have already been deducted from the payout amount in pence or cents.
getDefaultAudPayoutAccount() - Method in class com.gocardless.resources.Creditor.Links: ID of the bank account which is set up to receive payouts in AUD.
getDefaultDkkPayoutAccount() - Method in class com.gocardless.resources.Creditor.Links: ID of the bank account which is set up to receive payouts in DKK.
getDefaultEurPayoutAccount() - Method in class com.gocardless.resources.Creditor.Links: ID of the bank account which is set up to receive payouts in EUR.
getDefaultGbpPayoutAccount() - Method in class com.gocardless.resources.Creditor.Links: ID of the bank account which is set up to receive payouts in GBP.
getDefaultSekPayoutAccount() - Method in class com.gocardless.resources.Creditor.Links: ID of the bank account which is set up to receive payouts in SEK.
getDescription() - Method in class com.gocardless.resources.Event.Details: Human readable description of the cause.
getDescription() - Method in class com.gocardless.resources.Payment: A human-readable description of the payment.
getDescription() - Method in class com.gocardless.resources.RedirectFlow: A description of the item the customer is paying for.
getDetails() - Method in class com.gocardless.resources.Event
getDocumentationUrl() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns the URL to the documentation describing the error.
getEmail() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The support email address.
getEmail() - Method in class com.gocardless.resources.Customer: Customer’s email address.
getEnabled() - Method in class com.gocardless.resources.CreditorBankAccount: Boolean value showing whether the bank account is enabled or disabled.
getEnabled() - Method in class com.gocardless.resources.CustomerBankAccount: Boolean value showing whether the bank account is enabled or disabled.
getEndDate() - Method in class com.gocardless.resources.Subscription: Date on or after which no further payments should be created.
getErrorMessage() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns a human-readable description of the error.
getErrors() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns a list of errors.
getEvent() - Method in class com.gocardless.resources.CustomerNotification.Links: The event that triggered the notification to be scheduled.
getExpiresAt() - Method in class com.gocardless.resources.MandatePdf: The date and time at which the url will expire (10 minutes after the original request).
getFamilyName() - Method in class com.gocardless.resources.Customer: Customer’s surname.
getField() - Method in class com.gocardless.errors.ApiError: Returns the field that this error applies to.
getGivenName() - Method in class com.gocardless.resources.Customer: Customer’s first name.
getHeaders() - Method in class com.gocardless.http.ApiResponse
getId() - Method in class com.gocardless.resources.Creditor: Unique identifier, beginning with “CR”.
getId() - Method in class com.gocardless.resources.CreditorBankAccount: Unique identifier, beginning with “BA”.
getId() - Method in class com.gocardless.resources.Customer: Unique identifier, beginning with “CU”.
getId() - Method in class com.gocardless.resources.CustomerBankAccount: Unique identifier, beginning with “BA”.
getId() - Method in class com.gocardless.resources.CustomerNotification: The id of the notification.
getId() - Method in class com.gocardless.resources.Event.CustomerNotification: The id of the notification.
getId() - Method in class com.gocardless.resources.Event: Unique identifier, beginning with “EV”.
getId() - Method in class com.gocardless.resources.Mandate: Unique identifier, beginning with “MD”.
getId() - Method in class com.gocardless.resources.MandateImport: Unique identifier, beginning with “IM”.
getId() - Method in class com.gocardless.resources.Payment: Unique identifier, beginning with “PM”.
getId() - Method in class com.gocardless.resources.Payout: Unique identifier, beginning with “PO”.
getId() - Method in class com.gocardless.resources.RedirectFlow: Unique identifier, beginning with “RE”.
getId() - Method in class com.gocardless.resources.Refund: Unique identifier, beginning with “RF”.
getId() - Method in class com.gocardless.resources.Subscription: Unique identifier, beginning with “SB”.
getInterval() - Method in class com.gocardless.resources.Subscription: Number of interval_units between customer charge dates.
getIntervalUnit() - Method in class com.gocardless.resources.Subscription: The unit of time between customer charge dates.
getItems() - Method in class com.gocardless.http.ListResponse: Returns the items on this page.
getLanguage() - Method in class com.gocardless.resources.Customer: ISO 639-1 code.
getLimit() - Method in class com.gocardless.http.ListResponse: Returns the upper bound placed on the number of items returned.
getLinks() - Method in class com.gocardless.errors.ApiError: Returns the IDs of related objects.
getLinks() - Method in class com.gocardless.resources.Creditor
getLinks() - Method in class com.gocardless.resources.CreditorBankAccount
getLinks() - Method in class com.gocardless.resources.CustomerBankAccount
getLinks() - Method in class com.gocardless.resources.CustomerNotification
getLinks() - Method in class com.gocardless.resources.Event
getLinks() - Method in class com.gocardless.resources.Mandate
getLinks() - Method in class com.gocardless.resources.MandateImportEntry: Related resources
getLinks() - Method in class com.gocardless.resources.Payment
getLinks() - Method in class com.gocardless.resources.Payout
getLinks() - Method in class com.gocardless.resources.PayoutItem
getLinks() - Method in class com.gocardless.resources.RedirectFlow
getLinks() - Method in class com.gocardless.resources.Refund
getLinks() - Method in class com.gocardless.resources.Subscription
getLogoUrl() - Method in class com.gocardless.resources.Creditor: URL for the creditor’s logo, which may be shown on their payment pages.
getMandate() - Method in class com.gocardless.resources.CustomerNotification.Links: The identifier of the related mandate.
getMandate() - Method in class com.gocardless.resources.Event.Links: If resource_type is mandates, this is the ID of the mandate which has been updated.
getMandate() - Method in class com.gocardless.resources.MandateImportEntry.Links: The ID of the mandate which was created when the mandate import was processed.
getMandate() - Method in class com.gocardless.resources.Payment.Links: ID of the mandate against which this payment should be collected.
getMandate() - Method in class com.gocardless.resources.PayoutItem.Links: Unique identifier, beginning with “MD”.
getMandate() - Method in class com.gocardless.resources.RedirectFlow.Links: ID of mandate created by this redirect flow.
**Note**: this property will not be present until the redirect flow has been successfully completed.
getMandate() - Method in class com.gocardless.resources.Refund.Links: ID of the mandate against which the refund is being made.
getMandate() - Method in class com.gocardless.resources.Subscription.Links: ID of the associated mandate which the subscription will create payments against.
getMandateImport() - Method in class com.gocardless.resources.MandateImportEntry.Links: The ID of the mandate import.
getMandatory() - Method in class com.gocardless.resources.Event.CustomerNotification: Whether or not the notification must be sent.
getMessage() - Method in class com.gocardless.errors.ApiError: Returns a message describing the problem.
getMetadata() - Method in class com.gocardless.resources.CreditorBankAccount: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.Customer: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.CustomerBankAccount: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.Event: If the details[origin] is api, this will contain any metadata you specified when triggering this event.
getMetadata() - Method in class com.gocardless.resources.Mandate: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.Payment: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.Refund: Key-value store of custom data.
getMetadata() - Method in class com.gocardless.resources.Subscription: Key-value store of custom data.
getMinimumAdvanceNotice() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The minimum interval, in working days, between the sending of a pre-notification to the customer, and the charge date of a payment using this scheme identifier.
getMonth() - Method in class com.gocardless.resources.Subscription: Name of the month on which to charge a customer.
getName() - Method in class com.gocardless.resources.Creditor: The creditor’s name.
getName() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The name which appears on customers’ bank statements.
getName() - Method in class com.gocardless.resources.Subscription: Optional name for the subscription.
getNewCustomerBankAccount() - Method in class com.gocardless.resources.Event.Links: This is only included for mandate transfer events, when it is the ID of the customer bank account which the mandate is being transferred to.
getNewMandate() - Method in class com.gocardless.resources.Event.Links: This is only included for mandate replaced events, when it is the ID of the new mandate that replaces the existing mandate.
getNewMandate() - Method in class com.gocardless.resources.Mandate.Links: ID of the new mandate if this mandate has been replaced.
getNextPossibleChargeDate() - Method in class com.gocardless.resources.Mandate: The earliest date a newly created payment for this mandate could be charged.
getOrganisation() - Method in class com.gocardless.resources.Event.Links: If the event is included in a webhook to an OAuth app, this is the ID of the account to which it belongs.
getOrigin() - Method in class com.gocardless.resources.Event.Details: Who initiated the event.
getParentEvent() - Method in class com.gocardless.resources.Event.Links: If this event was caused by another, this is the ID of the cause.
getPayment() - Method in class com.gocardless.resources.CustomerNotification.Links: The identifier of the related payment.
getPayment() - Method in class com.gocardless.resources.Event.Links: If resource_type is payments, this is the ID of the payment which has been updated.
getPayment() - Method in class com.gocardless.resources.PayoutItem.Links: Unique identifier, beginning with “PM”.
getPayment() - Method in class com.gocardless.resources.Refund.Links: ID of the payment against which the refund is being made.
getPaymentReference() - Method in class com.gocardless.resources.Subscription: An optional payment reference.
getPaymentsRequireApproval() - Method in class com.gocardless.resources.Mandate: Boolean value showing whether payments and subscriptions under this mandate require approval via an automated email before being processed.
getPayout() - Method in class com.gocardless.resources.Event.Links: If resource_type is payouts, this is the ID of the payout which has been updated.
getPayout() - Method in class com.gocardless.resources.Payment.Links: ID of payout which contains the funds from this payment.
**Note**: this property will not be present until the payment has been successfully collected.
getPayoutType() - Method in class com.gocardless.resources.Payout: Whether a payout contains merchant revenue or partner fees.
getPhoneNumber() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The support phone number.
getPostalCode() - Method in class com.gocardless.resources.Creditor: The creditor’s postal code.
getPostalCode() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The support postal code.
getPostalCode() - Method in class com.gocardless.resources.Customer: The customer’s postal code.
getPreviousCustomerBankAccount() - Method in class com.gocardless.resources.Event.Links: This is only included for mandate transfer events, when it is the ID of the customer bank account which the mandate is being transferred from.
getQueryParams() - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.EventService.EventListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.MandateService.MandateListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.RefundService.RefundListRequest.CreatedAt
getQueryParams() - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt
getReason() - Method in class com.gocardless.errors.ApiError: Returns a key identifying the reason for this error.
getReasonCode() - Method in class com.gocardless.resources.Event.Details: Set when a bank is the origin of the event.
getRecordIdentifier() - Method in class com.gocardless.resources.MandateImportEntry: A unique identifier for this entry, which you can use (once the import has been processed by GoCardless) to identify the records that have been created.
getRedirectUrl() - Method in class com.gocardless.resources.RedirectFlow: The URL of the hosted payment pages for this redirect flow.
getReference() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The scheme-unique identifier against which payments are submitted.
getReference() - Method in class com.gocardless.resources.Mandate: Unique reference.
getReference() - Method in class com.gocardless.resources.Payment: An optional payment reference that will appear on your customer’s bank statement.
getReference() - Method in class com.gocardless.resources.Payout: Reference which appears on the creditor’s bank statement.
getReference() - Method in class com.gocardless.resources.Refund: An optional refund reference, displayed on your customer’s bank statement.
getRefund() - Method in class com.gocardless.resources.CustomerNotification.Links: The identifier of the related refund.
getRefund() - Method in class com.gocardless.resources.Event.Links: If resource_type is refunds, this is the ID of the refund which has been updated.
getRegion() - Method in class com.gocardless.resources.Creditor: The creditor’s address region, county or department.
getRegion() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The support address region, county or department.
getRegion() - Method in class com.gocardless.resources.Customer: The customer’s address region, county or department.
GetRequest<T> - Class in com.gocardless.http: Base class for GET requests that return a single item.
getRequestId() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns the ID of the request.
getRequestPointer() - Method in class com.gocardless.errors.ApiError: Returns the request pointer, indicating the exact field of the request that triggered the validation error
getResource() - Method in class com.gocardless.http.ApiResponse
getResourceType() - Method in class com.gocardless.resources.Event: The resource type for this event.
getResponseBody() - Method in exception com.gocardless.errors.MalformedResponseException
getScheme() - Method in class com.gocardless.resources.Creditor.SchemeIdentifier: The scheme which this scheme identifier applies to.
getScheme() - Method in class com.gocardless.resources.Event.Details: A Direct Debit scheme.
getScheme() - Method in class com.gocardless.resources.Mandate: Direct Debit scheme to which this mandate and associated payments are submitted.
getScheme() - Method in class com.gocardless.resources.MandateImport: The scheme of the mandates to be imported.
All mandates in a single mandate import must be for the same scheme.
getScheme() - Method in class com.gocardless.resources.RedirectFlow: The Direct Debit scheme of the mandate.
getSchemeIdentifiers() - Method in class com.gocardless.resources.Creditor: An array of the scheme identifiers this creditor can create mandates against.
getSessionToken() - Method in class com.gocardless.resources.RedirectFlow: The customer’s session ID must be provided when the redirect flow is set up and again when it is completed.
getStartDate() - Method in class com.gocardless.resources.Subscription: The date on which the first payment should be charged.
getStatus() - Method in class com.gocardless.resources.Mandate: One of: pending_customer_approval: the mandate has not yet been signed by the second customer pending_submission: the mandate has not yet been submitted to the customer’s bank submitted: the mandate has been submitted to the customer’s bank but has not been processed yet active: the mandate has been successfully set up by the customer’s bank failed: the mandate could not be created cancelled: the mandate has been cancelled expired: the mandate has expired due to dormancy
getStatus() - Method in class com.gocardless.resources.MandateImport: The status of the mandate import.
getStatus() - Method in class com.gocardless.resources.Payment: 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.
getStatus() - Method in class com.gocardless.resources.Payout: One of: pending: the payout has been created, but not yet sent to the banks paid: the payout has been sent to the banks
getStatus() - Method in class com.gocardless.resources.Subscription: One of: pending_customer_approval: the subscription is waiting for customer approval before becoming active customer_approval_denied: the customer did not approve the subscription active: the subscription is currently active and will continue to create payments finished: all of the payments scheduled for creation under this subscription have been created cancelled: the subscription has been cancelled and will no longer create payments
getStatusCode() - Method in class com.gocardless.http.ApiResponse
getSubscription() - Method in class com.gocardless.resources.CustomerNotification.Links: The identifier of the related subscription.
getSubscription() - Method in class com.gocardless.resources.Event.Links: If resource_type is subscription, this is the ID of the subscription which has been updated.
getSubscription() - Method in class com.gocardless.resources.Payment.Links: ID of subscription from which this payment was created.
**Note**: this property will only be present if this payment is part of a subscription.
getSuccessRedirectUrl() - Method in class com.gocardless.resources.RedirectFlow: The URL to redirect to upon successful mandate setup.
getSwedishIdentityNumber() - Method in class com.gocardless.resources.Customer: For Swedish customers only.
getType() - Method in exception com.gocardless.errors.GoCardlessApiException: Returns the type of the error.
getType() - Method in class com.gocardless.resources.CustomerNotification: The type of notification the customer shall receive.
getType() - Method in class com.gocardless.resources.Event.CustomerNotification: The type of notification the customer shall receive.
getType() - Method in class com.gocardless.resources.PayoutItem: The type of the credit (positive) or debit (negative) item in the payout.
getUpcomingPayments() - Method in class com.gocardless.resources.Subscription: Up to 10 upcoming payments with the amount, in pence, and charge date for each.
getUrl() - Method in class com.gocardless.resources.MandatePdf: The URL at which this mandate PDF can be viewed until it expires at the date and time specified by expires_at.
getVerificationStatus() - Method in class com.gocardless.resources.Creditor: The creditor’s verification status, indicating whether they can yet receive payouts.
GoCardlessApiException - Exception in com.gocardless.errors: Base class for exceptions that are thrown as a result of error responses from the API.
GoCardlessClient - Class in com.gocardless: Entry point into the client.
GoCardlessClient.Builder - Class in com.gocardless
GoCardlessClient.Environment - Enum in com.gocardless: Available environments for this client.
GoCardlessErrorMapper - Class in com.gocardless.errors: Provides a mapping between API error responses and exceptions.
GoCardlessErrorMapper() - Constructor for class com.gocardless.errors.GoCardlessErrorMapper
GoCardlessException - Exception in com.gocardless: Base class for client library exceptions.
GoCardlessInternalException - Exception in com.gocardless.errors: Exception thrown when an internal error occurred while processing your request.
GoCardlessNetworkException - Exception in com.gocardless.http: Exception thrown due to a network error.

H

handle(String) - Method in class com.gocardless.services.CustomerNotificationService: “Handling” a notification means that you have sent the notification yourself (and don’t want GoCardless to send it).
HttpClient - Class in com.gocardless.http: An HTTP client that can execute ApiRequests.
HttpClient(String, String, OkHttpClient) - Constructor for class com.gocardless.http.HttpClient: Constructor.

I

IdempotentPostRequest<T> - Class in com.gocardless.http
InvalidApiUsageException - Exception in com.gocardless.errors: Exception thrown when there is an error with the request you made.
InvalidSignatureException - Exception in com.gocardless.errors: Exception thrown when the signature included in a webhook doesn’t match one computed using the webhook endpoint’s secret and the request body, indicating that the webhook is not genuinely from GoCardless
InvalidSignatureException() - Constructor for exception com.gocardless.errors.InvalidSignatureException
InvalidStateException - Exception in com.gocardless.errors: Exception thrown when the action you are trying to perform is invalid due to the state of the resource you are requesting it on.
isValidSignature(String, String, String) - Static method in class com.gocardless.Webhook: Validates that a webhook was genuinely sent by GoCardless by computing its signature using the body and your webhook endpoint secret, and comparing that with the signature included in the Webhook-Signature header.
iteratingExecutor() - Static method in class com.gocardless.http.ListRequest

L

list() - Method in class com.gocardless.services.CreditorBankAccountService: Returns a cursor-paginated list of your creditor bank accounts.
list() - Method in class com.gocardless.services.CreditorService: Returns a cursor-paginated list of your creditors.
list() - Method in class com.gocardless.services.CustomerBankAccountService: Returns a cursor-paginated list of your bank accounts.
list() - Method in class com.gocardless.services.CustomerService: Returns a cursor-paginated list of your customers.
list() - Method in class com.gocardless.services.EventService: Returns a cursor-paginated list of your events.
list() - Method in class com.gocardless.services.MandateImportEntryService: For an existing mandate import, this endpoint lists all of the entries attached.
list() - Method in class com.gocardless.services.MandateService: Returns a cursor-paginated list of your mandates.
list() - Method in class com.gocardless.services.PaymentService: Returns a cursor-paginated list of your payments.
list() - Method in class com.gocardless.services.PayoutItemService: Returns a cursor-paginated list of items in the payout.
list() - Method in class com.gocardless.services.PayoutService: Returns a cursor-paginated list of your payouts.
list() - Method in class com.gocardless.services.RefundService: Returns a cursor-paginated list of your refunds.
list() - Method in class com.gocardless.services.SubscriptionService: Returns a cursor-paginated list of your subscriptions.
ListRequest<S,T> - Class in com.gocardless.http: Base class for GET requests that return multiple items.
ListRequest.ListRequestExecutor<S,T> - Interface in com.gocardless.http
ListResponse<T> - Class in com.gocardless.http: Represents a page of items returned from the API.

M

MalformedResponseException - Exception in com.gocardless.errors: Exception thrown when a response is returned from the API which isn’t valid JSON (for example, an HTML error page returned from a load balancer)
MalformedResponseException(String) - Constructor for exception com.gocardless.errors.MalformedResponseException
Mandate - Class in com.gocardless.resources: Represents a mandate resource returned from the API.
Mandate.Links - Class in com.gocardless.resources
Mandate.Status - Enum in com.gocardless.resources
MandateImport - Class in com.gocardless.resources: Represents a mandate import resource returned from the API.
MandateImport.Status - Enum in com.gocardless.resources
mandateImportEntries() - Method in class com.gocardless.GoCardlessClient: A service class for working with mandate import entry resources.
MandateImportEntry - Class in com.gocardless.resources: Represents a mandate import entry resource returned from the API.
MandateImportEntry.Links - Class in com.gocardless.resources: Represents a link resource returned from the API.
MandateImportEntryService - Class in com.gocardless.services: Service class for working with mandate import entry resources.
MandateImportEntryService(HttpClient) - Constructor for class com.gocardless.services.MandateImportEntryService: Constructor.
MandateImportEntryService.MandateImportEntryCreateRequest - Class in com.gocardless.services: Request class for MandateImportEntryService.create().
MandateImportEntryService.MandateImportEntryCreateRequest.Amendment - Class in com.gocardless.services
MandateImportEntryService.MandateImportEntryCreateRequest.Amendment() - Constructor for class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Amendment
MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount - Class in com.gocardless.services
MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount() - Constructor for class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount
MandateImportEntryService.MandateImportEntryCreateRequest.Customer - Class in com.gocardless.services
MandateImportEntryService.MandateImportEntryCreateRequest.Customer() - Constructor for class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer
MandateImportEntryService.MandateImportEntryCreateRequest.Links - Class in com.gocardless.services
MandateImportEntryService.MandateImportEntryCreateRequest.Links() - Constructor for class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Links
MandateImportEntryService.MandateImportEntryListRequest<S> - Class in com.gocardless.services: Request class for MandateImportEntryService.list().
mandateImports() - Method in class com.gocardless.GoCardlessClient: A service class for working with mandate import resources.
MandateImportService - Class in com.gocardless.services: Service class for working with mandate import resources.
MandateImportService(HttpClient) - Constructor for class com.gocardless.services.MandateImportService: Constructor.
MandateImportService.MandateImportCancelRequest - Class in com.gocardless.services: Request class for MandateImportService.cancel(java.lang.String).
MandateImportService.MandateImportCreateRequest - Class in com.gocardless.services: Request class for MandateImportService.create().
MandateImportService.MandateImportCreateRequest.Scheme - Enum in com.gocardless.services
MandateImportService.MandateImportGetRequest - Class in com.gocardless.services: Request class for MandateImportService.get(java.lang.String).
MandateImportService.MandateImportSubmitRequest - Class in com.gocardless.services: Request class for MandateImportService.submit(java.lang.String).
MandatePdf - Class in com.gocardless.resources: Represents a mandate pdf resource returned from the API.
mandatePdfs() - Method in class com.gocardless.GoCardlessClient: A service class for working with mandate pdf resources.
MandatePdfService - Class in com.gocardless.services: Service class for working with mandate pdf resources.
MandatePdfService(HttpClient) - Constructor for class com.gocardless.services.MandatePdfService: Constructor.
MandatePdfService.MandatePdfCreateRequest - Class in com.gocardless.services: Request class for MandatePdfService.create().
MandatePdfService.MandatePdfCreateRequest.Links - Class in com.gocardless.services
MandatePdfService.MandatePdfCreateRequest.Links() - Constructor for class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest.Links
mandates() - Method in class com.gocardless.GoCardlessClient: A service class for working with mandate resources.
MandateService - Class in com.gocardless.services: Service class for working with mandate resources.
MandateService(HttpClient) - Constructor for class com.gocardless.services.MandateService: Constructor.
MandateService.MandateCancelRequest - Class in com.gocardless.services: Request class for MandateService.cancel(java.lang.String).
MandateService.MandateCreateRequest - Class in com.gocardless.services: Request class for MandateService.create().
MandateService.MandateCreateRequest.Links - Class in com.gocardless.services
MandateService.MandateCreateRequest.Links() - Constructor for class com.gocardless.services.MandateService.MandateCreateRequest.Links
MandateService.MandateGetRequest - Class in com.gocardless.services: Request class for MandateService.get(java.lang.String).
MandateService.MandateListRequest<S> - Class in com.gocardless.services: Request class for MandateService.list().
MandateService.MandateListRequest.CreatedAt - Class in com.gocardless.services
MandateService.MandateListRequest.CreatedAt() - Constructor for class com.gocardless.services.MandateService.MandateListRequest.CreatedAt
MandateService.MandateListRequest.Status - Enum in com.gocardless.services
MandateService.MandateReinstateRequest - Class in com.gocardless.services: Request class for MandateService.reinstate(java.lang.String).
MandateService.MandateUpdateRequest - Class in com.gocardless.services: Request class for MandateService.update(java.lang.String).
MAX_RETRIES - Static variable in class com.gocardless.http.HttpClient: The maximum number of times that a request can be retried.

N

newBuilder(String) - Static method in class com.gocardless.GoCardlessClient: Returns a builder which can be used to configure and instantiate a GoCardlessClient instance.

P

pagingExecutor() - Static method in class com.gocardless.http.ListRequest
parse(String) - Static method in class com.gocardless.http.WebhookParser
parse(String, String, String) - Static method in class com.gocardless.Webhook: Validates that a webhook was genuinely sent by GoCardless using isValidSignature, and then parses it into an array of com.gocardless.resources.Event objects representing each event included in the webhook.
PathParam - Annotation Type in com.gocardless.http: Marks a field as a parameter used to construct the path for a request.
Payment - Class in com.gocardless.resources: Represents a payment resource returned from the API.
Payment.Currency - Enum in com.gocardless.resources
Payment.Links - Class in com.gocardless.resources
Payment.Status - Enum in com.gocardless.resources
payments() - Method in class com.gocardless.GoCardlessClient: A service class for working with payment resources.
PaymentService - Class in com.gocardless.services: Service class for working with payment resources.
PaymentService(HttpClient) - Constructor for class com.gocardless.services.PaymentService: Constructor.
PaymentService.PaymentCancelRequest - Class in com.gocardless.services: Request class for PaymentService.cancel(java.lang.String).
PaymentService.PaymentCreateRequest - Class in com.gocardless.services: Request class for PaymentService.create().
PaymentService.PaymentCreateRequest.Currency - Enum in com.gocardless.services
PaymentService.PaymentCreateRequest.Links - Class in com.gocardless.services
PaymentService.PaymentCreateRequest.Links() - Constructor for class com.gocardless.services.PaymentService.PaymentCreateRequest.Links
PaymentService.PaymentGetRequest - Class in com.gocardless.services: Request class for PaymentService.get(java.lang.String).
PaymentService.PaymentListRequest<S> - Class in com.gocardless.services: Request class for PaymentService.list().
PaymentService.PaymentListRequest.CreatedAt - Class in com.gocardless.services
PaymentService.PaymentListRequest.CreatedAt() - Constructor for class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt
PaymentService.PaymentListRequest.Currency - Enum in com.gocardless.services
PaymentService.PaymentListRequest.Status - Enum in com.gocardless.services
PaymentService.PaymentRetryRequest - Class in com.gocardless.services: Request class for PaymentService.retry(java.lang.String).
PaymentService.PaymentUpdateRequest - Class in com.gocardless.services: Request class for PaymentService.update(java.lang.String).
Payout - Class in com.gocardless.resources: Represents a payout resource returned from the API.
Payout.Currency - Enum in com.gocardless.resources
Payout.Links - Class in com.gocardless.resources
Payout.PayoutType - Enum in com.gocardless.resources
Payout.Status - Enum in com.gocardless.resources
PayoutItem - Class in com.gocardless.resources: Represents a payout item resource returned from the API.
PayoutItem.Links - Class in com.gocardless.resources
PayoutItem.Type - Enum in com.gocardless.resources
payoutItems() - Method in class com.gocardless.GoCardlessClient: A service class for working with payout item resources.
PayoutItemService - Class in com.gocardless.services: Service class for working with payout item resources.
PayoutItemService(HttpClient) - Constructor for class com.gocardless.services.PayoutItemService: Constructor.
PayoutItemService.PayoutItemListRequest<S> - Class in com.gocardless.services: Request class for PayoutItemService.list().
payouts() - Method in class com.gocardless.GoCardlessClient: A service class for working with payout resources.
PayoutService - Class in com.gocardless.services: Service class for working with payout resources.
PayoutService(HttpClient) - Constructor for class com.gocardless.services.PayoutService: Constructor.
PayoutService.PayoutGetRequest - Class in com.gocardless.services: Request class for PayoutService.get(java.lang.String).
PayoutService.PayoutListRequest<S> - Class in com.gocardless.services: Request class for PayoutService.list().
PayoutService.PayoutListRequest.CreatedAt - Class in com.gocardless.services
PayoutService.PayoutListRequest.CreatedAt() - Constructor for class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt
PayoutService.PayoutListRequest.Currency - Enum in com.gocardless.services
PayoutService.PayoutListRequest.PayoutType - Enum in com.gocardless.services
PayoutService.PayoutListRequest.Status - Enum in com.gocardless.services
PostRequest<T> - Class in com.gocardless.http: Base class for POST requests.
PutRequest<T> - Class in com.gocardless.http: Base class for PUT requests.

R

RedirectFlow - Class in com.gocardless.resources: Represents a redirect flow resource returned from the API.
RedirectFlow.Links - Class in com.gocardless.resources
RedirectFlow.Scheme - Enum in com.gocardless.resources
redirectFlows() - Method in class com.gocardless.GoCardlessClient: A service class for working with redirect flow resources.
RedirectFlowService - Class in com.gocardless.services: Service class for working with redirect flow resources.
RedirectFlowService(HttpClient) - Constructor for class com.gocardless.services.RedirectFlowService: Constructor.
RedirectFlowService.RedirectFlowCompleteRequest - Class in com.gocardless.services: Request class for RedirectFlowService.complete(java.lang.String).
RedirectFlowService.RedirectFlowCreateRequest - Class in com.gocardless.services: Request class for RedirectFlowService.create().
RedirectFlowService.RedirectFlowCreateRequest.Links - Class in com.gocardless.services
RedirectFlowService.RedirectFlowCreateRequest.Links() - Constructor for class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.Links
RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer - Class in com.gocardless.services
RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer() - Constructor for class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer
RedirectFlowService.RedirectFlowCreateRequest.Scheme - Enum in com.gocardless.services
RedirectFlowService.RedirectFlowGetRequest - Class in com.gocardless.services: Request class for RedirectFlowService.get(java.lang.String).
Refund - Class in com.gocardless.resources: Represents a refund resource returned from the API.
Refund.Links - Class in com.gocardless.resources
refunds() - Method in class com.gocardless.GoCardlessClient: A service class for working with refund resources.
RefundService - Class in com.gocardless.services: Service class for working with refund resources.
RefundService(HttpClient) - Constructor for class com.gocardless.services.RefundService: Constructor.
RefundService.RefundCreateRequest - Class in com.gocardless.services: Request class for RefundService.create().
RefundService.RefundCreateRequest.Links - Class in com.gocardless.services
RefundService.RefundCreateRequest.Links() - Constructor for class com.gocardless.services.RefundService.RefundCreateRequest.Links
RefundService.RefundGetRequest - Class in com.gocardless.services: Request class for RefundService.get(java.lang.String).
RefundService.RefundListRequest<S> - Class in com.gocardless.services: Request class for RefundService.list().
RefundService.RefundListRequest.CreatedAt - Class in com.gocardless.services
RefundService.RefundListRequest.CreatedAt() - Constructor for class com.gocardless.services.RefundService.RefundListRequest.CreatedAt
RefundService.RefundListRequest.RefundType - Enum in com.gocardless.services
RefundService.RefundUpdateRequest - Class in com.gocardless.services: Request class for RefundService.update(java.lang.String).
reinstate(String) - Method in class com.gocardless.services.MandateService: Reinstates a cancelled or expired mandate to the banks.
retry(String) - Method in class com.gocardless.services.PaymentService: Retries a failed payment if the underlying mandate is active.

S

submit(String) - Method in class com.gocardless.services.MandateImportService: Submits the mandate import, which allows it to be processed by a member of the GoCardless team.
Subscription - Class in com.gocardless.resources: Represents a subscription resource returned from the API.
Subscription.IntervalUnit - Enum in com.gocardless.resources
Subscription.Links - Class in com.gocardless.resources
Subscription.Month - Enum in com.gocardless.resources
Subscription.Status - Enum in com.gocardless.resources
Subscription.UpcomingPayment - Class in com.gocardless.resources
subscriptions() - Method in class com.gocardless.GoCardlessClient: A service class for working with subscription resources.
SubscriptionService - Class in com.gocardless.services: Service class for working with subscription resources.
SubscriptionService(HttpClient) - Constructor for class com.gocardless.services.SubscriptionService: Constructor.
SubscriptionService.SubscriptionCancelRequest - Class in com.gocardless.services: Request class for SubscriptionService.cancel(java.lang.String).
SubscriptionService.SubscriptionCreateRequest - Class in com.gocardless.services: Request class for SubscriptionService.create().
SubscriptionService.SubscriptionCreateRequest.IntervalUnit - Enum in com.gocardless.services
SubscriptionService.SubscriptionCreateRequest.Links - Class in com.gocardless.services
SubscriptionService.SubscriptionCreateRequest.Links() - Constructor for class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.Links
SubscriptionService.SubscriptionCreateRequest.Month - Enum in com.gocardless.services
SubscriptionService.SubscriptionGetRequest - Class in com.gocardless.services: Request class for SubscriptionService.get(java.lang.String).
SubscriptionService.SubscriptionListRequest<S> - Class in com.gocardless.services: Request class for SubscriptionService.list().
SubscriptionService.SubscriptionListRequest.CreatedAt - Class in com.gocardless.services
SubscriptionService.SubscriptionListRequest.CreatedAt() - Constructor for class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt
SubscriptionService.SubscriptionUpdateRequest - Class in com.gocardless.services: Request class for SubscriptionService.update(java.lang.String).

T

toException(ApiErrorResponse) - Static method in class com.gocardless.errors.GoCardlessErrorMapper: Maps an error response to an exception.
toString() - Method in class com.gocardless.errors.ApiError
toString() - Method in class com.gocardless.errors.ApiErrorResponse
toString() - Method in exception com.gocardless.errors.GoCardlessApiException
toString() - Method in enum com.gocardless.services.EventService.EventListRequest.Include
toString() - Method in enum com.gocardless.services.EventService.EventListRequest.ResourceType
toString() - Method in enum com.gocardless.services.MandateImportService.MandateImportCreateRequest.Scheme
toString() - Method in enum com.gocardless.services.MandateService.MandateListRequest.Status
toString() - Method in enum com.gocardless.services.PaymentService.PaymentCreateRequest.Currency
toString() - Method in enum com.gocardless.services.PaymentService.PaymentListRequest.Currency
toString() - Method in enum com.gocardless.services.PaymentService.PaymentListRequest.Status
toString() - Method in enum com.gocardless.services.PayoutService.PayoutListRequest.Currency
toString() - Method in enum com.gocardless.services.PayoutService.PayoutListRequest.PayoutType
toString() - Method in enum com.gocardless.services.PayoutService.PayoutListRequest.Status
toString() - Method in enum com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.Scheme
toString() - Method in enum com.gocardless.services.RefundService.RefundListRequest.RefundType
toString() - Method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.IntervalUnit
toString() - Method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.Month

U

update(String) - Method in class com.gocardless.services.CreditorService: Updates a creditor object.
update(String) - Method in class com.gocardless.services.CustomerBankAccountService: Updates a customer bank account object.
update(String) - Method in class com.gocardless.services.CustomerService: Updates a customer object.
update(String) - Method in class com.gocardless.services.MandateService: Updates a mandate object.
update(String) - Method in class com.gocardless.services.PaymentService: Updates a payment object.
update(String) - Method in class com.gocardless.services.RefundService: Updates a refund object.
update(String) - Method in class com.gocardless.services.SubscriptionService: Updates a subscription object.

V

ValidationFailedException - Exception in com.gocardless.errors: Exception thrown when the parameters submitted with your request were invalid.
valueOf(String) - Static method in enum com.gocardless.errors.ErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.GoCardlessClient.Environment: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.BankDetailsLookup.AvailableDebitScheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Creditor.SchemeIdentifier.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Creditor.SchemeIdentifier.Scheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Creditor.VerificationStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.CustomerNotification.ActionTaken: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.CustomerNotification.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Event.CustomerNotification.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Event.Details.Origin: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Event.Details.Scheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Event.ResourceType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Mandate.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.MandateImport.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Payment.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Payment.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Payout.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Payout.PayoutType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Payout.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.PayoutItem.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.RedirectFlow.Scheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Subscription.IntervalUnit: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Subscription.Month: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.resources.Subscription.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.EventService.EventListRequest.Include: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.EventService.EventListRequest.ResourceType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.MandateImportService.MandateImportCreateRequest.Scheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.MandateService.MandateListRequest.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PaymentService.PaymentCreateRequest.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PaymentService.PaymentListRequest.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PaymentService.PaymentListRequest.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.Currency: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.PayoutType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.Scheme: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.RefundService.RefundListRequest.RefundType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.IntervalUnit: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.Month: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.gocardless.errors.ErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.GoCardlessClient.Environment: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.BankDetailsLookup.AvailableDebitScheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Creditor.SchemeIdentifier.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Creditor.SchemeIdentifier.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Creditor.VerificationStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.CustomerNotification.ActionTaken: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.CustomerNotification.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Event.CustomerNotification.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Event.Details.Origin: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Event.Details.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Event.ResourceType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Mandate.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.MandateImport.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Payment.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Payment.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Payout.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Payout.PayoutType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Payout.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.PayoutItem.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.RedirectFlow.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Subscription.IntervalUnit: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Subscription.Month: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.resources.Subscription.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.EventService.EventListRequest.Include: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.EventService.EventListRequest.ResourceType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.MandateImportService.MandateImportCreateRequest.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.MandateService.MandateListRequest.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PaymentService.PaymentCreateRequest.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PaymentService.PaymentListRequest.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PaymentService.PaymentListRequest.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.Currency: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.PayoutType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.PayoutService.PayoutListRequest.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.RefundService.RefundListRequest.RefundType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.IntervalUnit: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.Month: Returns an array containing the constants of this enum type, in the order they are declared.

W

Webhook - Class in com.gocardless: Class containing a collection of functions for validating and parsing GoCardless webhooks
WebhookParser - Class in com.gocardless.http
withAccountHolderName(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Name of the account holder, as known by the bank.
withAccountHolderName(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Name of the account holder, as known by the bank.
withAccountHolderName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: Name of the account holder, as known by the bank.
withAccountHolderName(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Name of the account holder, as known by the bank.
withAccountNumber(String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest: Bank account number - see local details for more information.
withAccountNumber(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Bank account number - see local details for more information.
withAccountNumber(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Bank account number - see local details for more information.
withAccountNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: Bank account number - see local details for more information.
withAccountNumber(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Bank account number - see local details for more information.
withAction(String) - Method in class com.gocardless.services.EventService.EventListRequest: Limit to events with a given action.
withAddressLine1(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The first line of the creditor’s address.
withAddressLine1(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The first line of the creditor’s address.
withAddressLine1(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The first line of the customer’s address.
withAddressLine1(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The first line of the customer’s address.
withAddressLine1(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The first line of the customer’s address.
withAddressLine1(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The first line of the customer’s address.
withAddressLine1(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The first line of the customer’s address.
withAddressLine2(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The second line of the creditor’s address.
withAddressLine2(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The second line of the creditor’s address.
withAddressLine2(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The second line of the customer’s address.
withAddressLine2(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The second line of the customer’s address.
withAddressLine2(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The second line of the customer’s address.
withAddressLine2(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The second line of the customer’s address.
withAddressLine2(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The second line of the customer’s address.
withAddressLine3(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The third line of the creditor’s address.
withAddressLine3(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The third line of the creditor’s address.
withAddressLine3(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The third line of the customer’s address.
withAddressLine3(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The third line of the customer’s address.
withAddressLine3(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The third line of the customer’s address.
withAddressLine3(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The third line of the customer’s address.
withAddressLine3(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The third line of the customer’s address.
withAfter(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.EventService.EventListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.PayoutItemService.PayoutItemListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Cursor pointing to the start of the desired set.
withAfter(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Cursor pointing to the start of the desired set.
withAmendment(MandateImportEntryService.MandateImportEntryCreateRequest.Amendment) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest
withAmendmentOriginalCreditorId(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The creditor identifier of the direct debit originator.
withAmendmentOriginalCreditorName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Data about the original mandate to be moved or modified.
withAmendmentOriginalMandateReference(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The unique SEPA reference for the mandate being amended.
withAmount(Integer) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
withAmount(Integer) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: Amount in pence/cents/öre.
withAmount(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
withAmount(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
withAppFee(Integer) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: The amount to be deducted from the payment as the OAuth app’s fee, in pence/cents/öre/øre.
withAppFee(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: The amount to be deducted from each payment as an app fee, to be paid to the partner integration which created the subscription, in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
withAppFee(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: The amount to be deducted from each payment as an app fee, to be paid to the partner integration which created the subscription, in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
withBankAccount(MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest
withBankAccountAccountHolderName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Name of the account holder, as known by the bank.
withBankAccountAccountNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Bank account number - see local details for more information.
withBankAccountBankCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Bank code - see local details for more information.
withBankAccountBranchCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Branch code - see local details for more information.
withBankAccountCountryCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: ISO 3166-1 alpha-2 code.
withBankAccountIban(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: International Bank Account Number.
withBankCode(String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest: Bank code - see local details for more information.
withBankCode(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Bank code - see local details for more information.
withBankCode(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Bank code - see local details for more information.
withBankCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: Bank code - see local details for more information.
withBankCode(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Bank code - see local details for more information.
withBaseUrl(String) - Method in class com.gocardless.GoCardlessClient.Builder: Configures the base URL for the client
withBefore(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.EventService.EventListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.PayoutItemService.PayoutItemListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Cursor pointing to the end of the desired set.
withBefore(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Cursor pointing to the end of the desired set.
withBic(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: SWIFT BIC.
withBranchCode(String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest: Branch code - see local details for more information.
withBranchCode(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Branch code - see local details for more information.
withBranchCode(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Branch code - see local details for more information.
withBranchCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: Branch code - see local details for more information.
withBranchCode(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Branch code - see local details for more information.
withChargeDate(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: A future date on which the payment should be collected.
withCity(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The city of the creditor’s address.
withCity(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The city of the creditor’s address.
withCity(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The city of the customer’s address.
withCity(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The city of the customer’s address.
withCity(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The city of the customer’s address.
withCity(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The city of the customer’s address.
withCity(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The city of the customer’s address.
withCompanyName(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Customer’s company name.
withCompanyName(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Customer’s company name.
withCompanyName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: Customer’s company name.
withCompanyName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: Customer’s company name.
withCount(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: The total number of payments that should be taken by this subscription.
withCountryCode(String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: ISO 3166-1 alpha-2 code.
withCountryCode(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: ISO 3166-1 alpha-2 code.
withCreatedAt(CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest
withCreatedAt(CreditorService.CreditorListRequest.CreatedAt) - Method in class com.gocardless.services.CreditorService.CreditorListRequest
withCreatedAt(CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest
withCreatedAt(CustomerService.CustomerListRequest.CreatedAt) - Method in class com.gocardless.services.CustomerService.CustomerListRequest
withCreatedAt(EventService.EventListRequest.CreatedAt) - Method in class com.gocardless.services.EventService.EventListRequest
withCreatedAt(MandateService.MandateListRequest.CreatedAt) - Method in class com.gocardless.services.MandateService.MandateListRequest
withCreatedAt(PaymentService.PaymentListRequest.CreatedAt) - Method in class com.gocardless.services.PaymentService.PaymentListRequest
withCreatedAt(PayoutService.PayoutListRequest.CreatedAt) - Method in class com.gocardless.services.PayoutService.PayoutListRequest
withCreatedAt(RefundService.RefundListRequest.CreatedAt) - Method in class com.gocardless.services.RefundService.RefundListRequest
withCreatedAt(SubscriptionService.SubscriptionListRequest.CreatedAt) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest
withCreatedAtGt(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.EventService.EventListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Limit to records created after the specified date-time.
withCreatedAtGt(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Limit to records created after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.EventService.EventListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Limit to records created on or after the specified date-time.
withCreatedAtGte(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Limit to records created on or after the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.EventService.EventListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Limit to records created before the specified date-time.
withCreatedAtLt(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Limit to records created before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.EventService.EventListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Limit to records created on or before the specified date-time.
withCreatedAtLte(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Limit to records created on or before the specified date-time.
withCreditor(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest.Links: ID of the creditor that owns this bank account.
withCreditor(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Unique identifier, beginning with “CR”.
withCreditor(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest.Links: ID of the associated creditor.
withCreditor(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: ID of a creditor.
withCreditor(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: ID of a creditor to filter payments by.
withCreditor(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Unique identifier, beginning with “CR”.
withCreditor(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.Links: The creditor for whom the mandate will be created.
withCreditorBankAccount(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Unique identifier, beginning with “BA”.
withCurrency(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: ISO 4217 currency code, defaults to national currency of country_code.
withCurrency(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: ISO 4217 currency code, defaults to national currency of country_code.
withCurrency(PaymentService.PaymentCreateRequest.Currency) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: ISO 4217 currency code.
withCurrency(PaymentService.PaymentListRequest.Currency) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: ISO 4217 currency code.
withCurrency(PayoutService.PayoutListRequest.Currency) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: ISO 4217 currency code.
withCurrency(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: ISO 4217 currency code.
withCustomer(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest.Links: ID of the customer that owns this bank account.
withCustomer(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Unique identifier, beginning with “CU”.
withCustomer(MandateImportEntryService.MandateImportEntryCreateRequest.Customer) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest
withCustomer(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: ID of a customer.
withCustomer(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: ID of a customer to filter payments by.
withCustomer(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Unique identifier, beginning with “CU”.
withCustomerAddressLine1(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The first line of the customer’s address.
withCustomerAddressLine2(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The second line of the customer’s address.
withCustomerAddressLine3(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The third line of the customer’s address.
withCustomerBankAccount(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest.Links: ID of the associated customer bank account which the mandate is created and submits payments against.
withCustomerBankAccount(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: ID of a customer bank account.
withCustomerBankAccountToken(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest.Links: ID of a customer bank account token to use in place of bank account parameters.
withCustomerCity(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The city of the customer’s address.
withCustomerCompanyName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Customer’s company name.
withCustomerCountryCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: ISO 3166-1 alpha-2 code.
withCustomerDanishIdentityNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: For Danish customers only.
withCustomerEmail(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Customer’s email address.
withCustomerFamilyName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Customer’s surname.
withCustomerGivenName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Customer’s first name.
withCustomerLanguage(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: ISO 639-1 code.
withCustomerPostalCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The customer’s postal code.
withCustomerRegion(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: The customer’s address region, county or department.
withCustomerSwedishIdentityNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: For Swedish customers only.
withDanishIdentityNumber(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: For Danish customers only.
withDanishIdentityNumber(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: For Danish customers only.
withDanishIdentityNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: For Danish customers only.
withDanishIdentityNumber(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: For Danish customers only.
withDanishIdentityNumber(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: For Danish customers only.
withDayOfMonth(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: As per RFC 2445.
withDefaultDkkPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest.Links: ID of the bank account which is set up to receive payouts in DKK.
withDefaultEurPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest.Links: ID of the bank account which is set up to receive payouts in EUR.
withDefaultGbpPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest.Links: ID of the bank account which is set up to receive payouts in GBP.
withDefaultSekPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest.Links: ID of the bank account which is set up to receive payouts in SEK.
withDescription(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: A human-readable description of the payment.
withDescription(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: A description of the item the customer is paying for.
withEmail(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Customer’s email address.
withEmail(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Customer’s email address.
withEmail(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: Customer’s email address.
withEmail(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: Customer’s email address.
withEnabled(Boolean) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Boolean value showing whether the bank account is enabled or disabled
withEnabled(Boolean) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Get enabled or disabled customer bank accounts.
withEndDate(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Date on or after which no further payments should be created.
withEnvironment(GoCardlessClient.Environment) - Method in class com.gocardless.GoCardlessClient.Builder: Configures the GoCardless environment for the client
withFamilyName(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Customer’s surname.
withFamilyName(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Customer’s surname.
withFamilyName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: Customer’s surname.
withFamilyName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: Customer’s surname.
withGivenName(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Customer’s first name.
withGivenName(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Customer’s first name.
withGivenName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: Customer’s first name.
withGivenName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: Customer’s first name.
withGt(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.EventService.EventListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.MandateService.MandateListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.RefundService.RefundListRequest.CreatedAt: Limit to records created after the specified date-time.
withGt(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt: Limit to records created after the specified date-time.
withGte(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.EventService.EventListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.MandateService.MandateListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.RefundService.RefundListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withGte(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt: Limit to records created on or after the specified date-time.
withHeader(String, String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountDisableRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountGetRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorService.CreditorGetRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest
withHeader(String, String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountDisableRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountGetRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerNotificationService.CustomerNotificationHandleRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerService.CustomerGetRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest
withHeader(String, String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.EventService.EventGetRequest
withHeader(String, String) - Method in class com.gocardless.services.EventService.EventListRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryListRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportService.MandateImportCancelRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportService.MandateImportCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportService.MandateImportGetRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateImportService.MandateImportSubmitRequest
withHeader(String, String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateCancelRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateGetRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateListRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateReinstateRequest
withHeader(String, String) - Method in class com.gocardless.services.MandateService.MandateUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentCancelRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentGetRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentRetryRequest
withHeader(String, String) - Method in class com.gocardless.services.PaymentService.PaymentUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.PayoutItemService.PayoutItemListRequest
withHeader(String, String) - Method in class com.gocardless.services.PayoutService.PayoutGetRequest
withHeader(String, String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest
withHeader(String, String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCompleteRequest
withHeader(String, String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowGetRequest
withHeader(String, String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.RefundService.RefundGetRequest
withHeader(String, String) - Method in class com.gocardless.services.RefundService.RefundListRequest
withHeader(String, String) - Method in class com.gocardless.services.RefundService.RefundUpdateRequest
withHeader(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCancelRequest
withHeader(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest
withHeader(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionGetRequest
withHeader(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest
withHeader(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest
withIban(String) - Method in class com.gocardless.services.BankDetailsLookupService.BankDetailsLookupCreateRequest: International Bank Account Number.
withIban(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: International Bank Account Number.
withIban(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: International Bank Account Number.
withIban(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount: International Bank Account Number.
withIban(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: International Bank Account Number.
withIdempotencyKey(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.MandateImportService.MandateImportCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest
withIdempotencyKey(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest
withInclude(EventService.EventListRequest.Include) - Method in class com.gocardless.services.EventService.EventListRequest: Includes linked resources in the response.
withInterval(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Number of interval_units between customer charge dates.
withIntervalUnit(SubscriptionService.SubscriptionCreateRequest.IntervalUnit) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: The unit of time between customer charge dates.
withLanguage(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: ISO 639-1 code.
withLanguage(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: ISO 639-1 code.
withLanguage(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: ISO 639-1 code.
withLanguage(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: ISO 639-1 code.
withLimit(Integer) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.CreditorService.CreditorListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.CustomerService.CustomerListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.EventService.EventListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.MandateService.MandateListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.PayoutItemService.PayoutItemListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.RefundService.RefundListRequest: Number of records to return.
withLimit(Integer) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Number of records to return.
withLinks(CreditorBankAccountService.CreditorBankAccountCreateRequest.Links) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest
withLinks(Map<String, String>) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest
withLinks(String, String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest
withLinks(CreditorService.CreditorUpdateRequest.Links) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest
withLinks(CustomerBankAccountService.CustomerBankAccountCreateRequest.Links) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest
withLinks(MandateImportEntryService.MandateImportEntryCreateRequest.Links) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest
withLinks(MandatePdfService.MandatePdfCreateRequest.Links) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest
withLinks(MandateService.MandateCreateRequest.Links) - Method in class com.gocardless.services.MandateService.MandateCreateRequest
withLinks(PaymentService.PaymentCreateRequest.Links) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest
withLinks(RedirectFlowService.RedirectFlowCreateRequest.Links) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest
withLinks(RefundService.RefundCreateRequest.Links) - Method in class com.gocardless.services.RefundService.RefundCreateRequest
withLinks(SubscriptionService.SubscriptionCreateRequest.Links) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest
withLinksCreditor(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: ID of the creditor that owns this bank account.
withLinksCreditor(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: ID of the associated creditor.
withLinksCreditor(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The creditor for whom the mandate will be created.
withLinksCustomer(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: ID of the customer that owns this bank account.
withLinksCustomerBankAccount(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: ID of the associated customer bank account which the mandate is created and submits payments against.
withLinksCustomerBankAccountToken(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: ID of a customer bank account token to use in place of bank account parameters.
withLinksDefaultDkkPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: ID of the bank account which is set up to receive payouts in DKK.
withLinksDefaultEurPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: ID of the bank account which is set up to receive payouts in EUR.
withLinksDefaultGbpPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: ID of the bank account which is set up to receive payouts in GBP.
withLinksDefaultSekPayoutAccount(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: ID of the bank account which is set up to receive payouts in SEK.
withLinksMandate(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: ID of an existing mandate to build the PDF from.
withLinksMandate(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: ID of the mandate against which this payment should be collected.
withLinksMandate(Map<String, String>) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: private beta ID of the mandate against which the refund is being made.
withLinksMandate(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: ID of the associated mandate which the subscription will create payments against.
withLinksMandateImport(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: Unique identifier, beginning with “IM”.
withLinksPayment(String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: ID of the payment against which the refund is being made.
withLt(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.EventService.EventListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.MandateService.MandateListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.RefundService.RefundListRequest.CreatedAt: Limit to records created before the specified date-time.
withLt(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt: Limit to records created before the specified date-time.
withLte(String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.CreditorService.CreditorListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.CustomerService.CustomerListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.EventService.EventListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.MandateService.MandateListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.RefundService.RefundListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withLte(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest.CreatedAt: Limit to records created on or before the specified date-time.
withMandate(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of a mandate.
withMandate(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest.Links: ID of an existing mandate to build the PDF from.
withMandate(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest.Links: ID of the mandate against which this payment should be collected.
withMandate(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Unique identifier, beginning with “MD”.
withMandate(Map<String, String>) - Method in class com.gocardless.services.RefundService.RefundCreateRequest.Links: private beta ID of the mandate against which the refund is being made.
withMandate(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Unique identifier, beginning with “MD”.
withMandate(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest.Links: ID of the associated mandate which the subscription will create payments against.
withMandate(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: Unique identifier, beginning with “MD”.
withMandateImport(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Links: Unique identifier, beginning with “IM”.
withMandateImport(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryListRequest: Unique identifier, beginning with “IM”.
withMandateReference(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Unique 6 to 18 character reference.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.CustomerBankAccountService.CustomerBankAccountUpdateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.MandateService.MandateCancelRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.MandateService.MandateCancelRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.MandateService.MandateReinstateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.MandateService.MandateReinstateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.MandateService.MandateUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.MandateService.MandateUpdateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.PaymentService.PaymentCancelRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.PaymentService.PaymentCancelRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.PaymentService.PaymentRetryRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.PaymentService.PaymentRetryRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.PaymentService.PaymentUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.PaymentService.PaymentUpdateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.RefundService.RefundUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.RefundService.RefundUpdateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCancelRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCancelRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Key-value store of custom data.
withMetadata(Map<String, String>) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: Key-value store of custom data.
withMetadata(String, String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: Key-value store of custom data.
withMonth(SubscriptionService.SubscriptionCreateRequest.Month) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Name of the month on which to charge a customer.
withName(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The creditor’s name.
withName(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The creditor’s name.
withName(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: Optional name for the subscription.
withName(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: Optional name for the subscription.
withOriginalCreditorId(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Amendment: The creditor identifier of the direct debit originator.
withOriginalCreditorName(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Amendment: Data about the original mandate to be moved or modified.
withOriginalMandateReference(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Amendment: The unique SEPA reference for the mandate being amended.
withParentEvent(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of an event.
withPayment(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of a payment.
withPayment(String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest.Links: ID of the payment against which the refund is being made.
withPayment(String) - Method in class com.gocardless.services.RefundService.RefundListRequest: Unique identifier, beginning with “PM”.
withPaymentReference(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: An optional payment reference.
withPaymentReference(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionUpdateRequest: An optional payment reference.
withPayout(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of a payout.
withPayout(String) - Method in class com.gocardless.services.PayoutItemService.PayoutItemListRequest: Unique identifier, beginning with “PO”.
withPayoutType(PayoutService.PayoutListRequest.PayoutType) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Whether a payout contains merchant revenue or partner fees.
withPostalCode(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The creditor’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The creditor’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The customer’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The customer’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The customer’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The customer’s postal code.
withPostalCode(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The customer’s postal code.
withPrefilledCustomer(RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: Information used to prefill the payment page so your customer doesn’t have to re-type details you already hold about them.
withPrefilledCustomerAddressLine1(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The first line of the customer’s address.
withPrefilledCustomerAddressLine2(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The second line of the customer’s address.
withPrefilledCustomerAddressLine3(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The third line of the customer’s address.
withPrefilledCustomerCity(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The city of the customer’s address.
withPrefilledCustomerCompanyName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: Customer’s company name.
withPrefilledCustomerCountryCode(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: ISO 3166-1 alpha-2 code.
withPrefilledCustomerDanishIdentityNumber(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: For Danish customers only.
withPrefilledCustomerEmail(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: Customer’s email address.
withPrefilledCustomerFamilyName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: Customer’s surname.
withPrefilledCustomerGivenName(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: Customer’s first name.
withPrefilledCustomerLanguage(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: ISO 639-1 code.
withPrefilledCustomerPostalCode(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The customer’s postal code.
withPrefilledCustomerRegion(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The customer’s address region, county or department.
withPrefilledCustomerSwedishIdentityNumber(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: For Swedish customers only.
withProxy(Proxy) - Method in class com.gocardless.GoCardlessClient.Builder: Configures the proxy to use for HTTP requests made by the client
withRecordIdentifier(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest: A unique identifier for this entry, which you can use (once the import has been processed by GoCardless) to identify the records that have been created.
withReference(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: Unique reference.
withReference(String) - Method in class com.gocardless.services.MandateService.MandateListRequest: Unique reference.
withReference(String) - Method in class com.gocardless.services.PaymentService.PaymentCreateRequest: An optional payment reference that will appear on your customer’s bank statement.
withReference(String) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: Reference which appears on the creditor’s bank statement.
withReference(String) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: An optional refund reference, displayed on your customer’s bank statement.
withRefund(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of a refund.
withRefundType(RefundService.RefundListRequest.RefundType) - Method in class com.gocardless.services.RefundService.RefundListRequest: Whether a refund was issued against a mandate or a payment.
withRegion(String) - Method in class com.gocardless.services.CreditorService.CreditorCreateRequest: The creditor’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.CreditorService.CreditorUpdateRequest: The creditor’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: The customer’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: The customer’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: The customer’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: The customer’s address region, county or department.
withRegion(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: The customer’s address region, county or department.
withResourceType(EventService.EventListRequest.ResourceType) - Method in class com.gocardless.services.EventService.EventListRequest: Type of resource that you’d like to get all events for.
withScheme(MandateImportService.MandateImportCreateRequest.Scheme) - Method in class com.gocardless.services.MandateImportService.MandateImportCreateRequest: A Direct Debit scheme.
withScheme(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: Direct Debit scheme.
withScheme(String) - Method in class com.gocardless.services.MandateService.MandateCreateRequest: Direct Debit scheme to which this mandate and associated payments are submitted.
withScheme(RedirectFlowService.RedirectFlowCreateRequest.Scheme) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The Direct Debit scheme of the mandate.
withSessionToken(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCompleteRequest: The customer’s session ID must be provided when the redirect flow is set up and again when it is completed.
withSessionToken(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The customer’s session ID must be provided when the redirect flow is set up and again when it is completed.
withSetAsDefaultPayoutAccount(Boolean) - Method in class com.gocardless.services.CreditorBankAccountService.CreditorBankAccountCreateRequest: Defaults to false.
withSignatureDate(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: If provided, a form will be generated with this date and no signature field.
withSslSocketFactory(SSLSocketFactory) - Method in class com.gocardless.GoCardlessClient.Builder: Configures the SSL socket factory to be used when making HTTP requests
withStartDate(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionCreateRequest: The date on which the first payment should be charged.
withStatus(List<MandateService.MandateListRequest.Status>) - Method in class com.gocardless.services.MandateService.MandateListRequest: At most four valid status values
withStatus(MandateService.MandateListRequest.Status) - Method in class com.gocardless.services.MandateService.MandateListRequest: At most four valid status values
withStatus(PaymentService.PaymentListRequest.Status) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: 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.
withStatus(PayoutService.PayoutListRequest.Status) - Method in class com.gocardless.services.PayoutService.PayoutListRequest: One of: pending: the payout has been created, but not yet sent to the banks paid: the payout has been sent to the banks
withStatus(List<String>) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: At most four valid status values
withStatus(String) - Method in class com.gocardless.services.SubscriptionService.SubscriptionListRequest: At most four valid status values
withSubscription(String) - Method in class com.gocardless.services.EventService.EventListRequest: ID of a subscription.
withSubscription(String) - Method in class com.gocardless.services.PaymentService.PaymentListRequest: Unique identifier, beginning with “SB”.
withSuccessRedirectUrl(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest: The URL to redirect to upon successful mandate setup.
withSwedishIdentityNumber(String) - Method in class com.gocardless.services.CustomerService.CustomerCreateRequest: For Swedish customers only.
withSwedishIdentityNumber(String) - Method in class com.gocardless.services.CustomerService.CustomerUpdateRequest: For Swedish customers only.
withSwedishIdentityNumber(String) - Method in class com.gocardless.services.MandateImportEntryService.MandateImportEntryCreateRequest.Customer: For Swedish customers only.
withSwedishIdentityNumber(String) - Method in class com.gocardless.services.MandatePdfService.MandatePdfCreateRequest: For Swedish customers only.
withSwedishIdentityNumber(String) - Method in class com.gocardless.services.RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer: For Swedish customers only.
withTotalAmountConfirmation(Integer) - Method in class com.gocardless.services.RefundService.RefundCreateRequest: Total expected refunded amount in pence/cents/öre.

A B C D E G H I L M N P R S T U V W