public class CreditorBankAccountService
extends java.lang.Object
Service class for working with creditor bank account resources.
Creditor Bank Accounts hold the bank details of a creditor. These are the bank accounts which your payouts will be sent to.
Note that creditor bank accounts must be unique, and so you will encounter a bank_account_exists error if you try to create a duplicate bank account. You may wish to handle this by updating the existing record instead, the ID of which will be provided as links[creditor_bank_account] in the error response.
Restricted: This API is not available for partner integrations.
| Modifier and Type | Class and Description |
|---|---|
static class |
CreditorBankAccountService.CreditorBankAccountCreateRequest
Request class for
create(). |
static class |
CreditorBankAccountService.CreditorBankAccountDisableRequest
Request class for
disable(java.lang.String). |
static class |
CreditorBankAccountService.CreditorBankAccountGetRequest
Request class for
get(java.lang.String). |
static class |
CreditorBankAccountService.CreditorBankAccountListRequest<S>
Request class for
list(). |
| Constructor and Description |
|---|
CreditorBankAccountService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
CreditorBankAccountService.CreditorBankAccountListRequest<java.lang.Iterable<CreditorBankAccount>> |
all() |
CreditorBankAccountService.CreditorBankAccountCreateRequest |
create()
Creates a new creditor bank account object.
|
CreditorBankAccountService.CreditorBankAccountDisableRequest |
disable(java.lang.String identity)
Immediately disables the bank account, no money can be paid out to a disabled account.
|
CreditorBankAccountService.CreditorBankAccountGetRequest |
get(java.lang.String identity)
Retrieves the details of an existing creditor bank account.
|
CreditorBankAccountService.CreditorBankAccountListRequest<ListResponse<CreditorBankAccount>> |
list()
Returns a cursor-paginated list of your creditor bank accounts.
|
public CreditorBankAccountService(HttpClient httpClient)
Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.creditorBankAccounts().
public CreditorBankAccountService.CreditorBankAccountCreateRequest create()
Creates a new creditor bank account object.
public CreditorBankAccountService.CreditorBankAccountListRequest<ListResponse<CreditorBankAccount>> list()
Returns a cursor-paginated list of your creditor bank accounts.
public CreditorBankAccountService.CreditorBankAccountListRequest<java.lang.Iterable<CreditorBankAccount>> all()
public CreditorBankAccountService.CreditorBankAccountGetRequest get(java.lang.String identity)
Retrieves the details of an existing creditor bank account.
public CreditorBankAccountService.CreditorBankAccountDisableRequest disable(java.lang.String identity)
Immediately disables the bank account, no money can be paid out to a disabled account.
This will return a disable_failed error if the bank account has already been disabled.
A disabled bank account can be re-enabled by creating a new bank account resource with the same details.