com.gocardless.services.CreditorBankAccountService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gocardless-pro Show documentation
Show all versions of gocardless-pro Show documentation
Client library for accessing the GoCardless Pro API
package com.gocardless.services;
import com.gocardless.http.*;
import com.gocardless.resources.CreditorBankAccount;
import com.google.common.collect.ImmutableMap;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Service class for working with creditor bank account resources.
*
* Creditor Bank Accounts hold the bank details of a [creditor](#core-endpoints-creditors). These
* are the bank accounts which your [payouts](#core-endpoints-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.
*
*/
public class CreditorBankAccountService {
private final HttpClient httpClient;
/**
* Constructor. Users of this library should have no need to call this - an instance of this
* class can be obtained by calling
* {@link com.gocardless.GoCardlessClient#creditorBankAccounts() }.
*/
public CreditorBankAccountService(HttpClient httpClient) {
this.httpClient = httpClient;
}
/**
* Creates a new creditor bank account object.
*/
public CreditorBankAccountCreateRequest create() {
return new CreditorBankAccountCreateRequest(httpClient);
}
/**
* Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank
* accounts.
*/
public CreditorBankAccountListRequest> list() {
return new CreditorBankAccountListRequest<>(httpClient,
ListRequest.pagingExecutor());
}
public CreditorBankAccountListRequest> all() {
return new CreditorBankAccountListRequest<>(httpClient,
ListRequest.iteratingExecutor());
}
/**
* Retrieves the details of an existing creditor bank account.
*/
public CreditorBankAccountGetRequest get(String identity) {
return new CreditorBankAccountGetRequest(httpClient, 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.
*/
public CreditorBankAccountDisableRequest disable(String identity) {
return new CreditorBankAccountDisableRequest(httpClient, identity);
}
/**
* Request class for {@link CreditorBankAccountService#create }.
*
* Creates a new creditor bank account object.
*/
public static final class CreditorBankAccountCreateRequest
extends IdempotentPostRequest {
private String accountHolderName;
private String accountNumber;
private AccountType accountType;
private String bankCode;
private String branchCode;
private String countryCode;
private String currency;
private String iban;
private Links links;
private Map metadata;
private Boolean setAsDefaultPayoutAccount;
/**
* Name of the account holder, as known by the bank. Usually this is the same as the name
* stored with the linked [creditor](#core-endpoints-creditors). This field will be
* transliterated, upcased and truncated to 18 characters.
*/
public CreditorBankAccountCreateRequest withAccountHolderName(String accountHolderName) {
this.accountHolderName = accountHolderName;
return this;
}
/**
* Bank account number - see [local details](#appendix-local-bank-details) for more
* information. Alternatively you can provide an `iban`.
*/
public CreditorBankAccountCreateRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
return this;
}
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See [local details](#local-bank-details-united-states)
* for more information.
*/
public CreditorBankAccountCreateRequest withAccountType(AccountType accountType) {
this.accountType = accountType;
return this;
}
/**
* Bank code - see [local details](#appendix-local-bank-details) for more information.
* Alternatively you can provide an `iban`.
*/
public CreditorBankAccountCreateRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
return this;
}
/**
* Branch code - see [local details](#appendix-local-bank-details) for more information.
* Alternatively you can provide an `iban`.
*/
public CreditorBankAccountCreateRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
return this;
}
/**
* [ISO 3166-1 alpha-2
* code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
* Defaults to the country code of the `iban` if supplied, otherwise is required.
*/
public CreditorBankAccountCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
return this;
}
/**
* [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
* "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public CreditorBankAccountCreateRequest withCurrency(String currency) {
this.currency = currency;
return this;
}
/**
* International Bank Account Number. Alternatively you can provide [local
* details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
* denominated in SEK - you must supply [local details](#local-bank-details-sweden).
*/
public CreditorBankAccountCreateRequest withIban(String iban) {
this.iban = iban;
return this;
}
public CreditorBankAccountCreateRequest withLinks(Links links) {
this.links = links;
return this;
}
/**
* ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
*/
public CreditorBankAccountCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
links = new Links();
}
links.withCreditor(creditor);
return this;
}
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
* characters and values up to 500 characters.
*/
public CreditorBankAccountCreateRequest withMetadata(Map metadata) {
this.metadata = metadata;
return this;
}
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
* characters and values up to 500 characters.
*/
public CreditorBankAccountCreateRequest withMetadata(String key, String value) {
if (metadata == null) {
metadata = new HashMap<>();
}
metadata.put(key, value);
return this;
}
/**
* Defaults to `true`. When this is set to `true`, it will cause this bank account to be set
* as the account that GoCardless will pay out to.
*/
public CreditorBankAccountCreateRequest withSetAsDefaultPayoutAccount(
Boolean setAsDefaultPayoutAccount) {
this.setAsDefaultPayoutAccount = setAsDefaultPayoutAccount;
return this;
}
public CreditorBankAccountCreateRequest withIdempotencyKey(String idempotencyKey) {
super.setIdempotencyKey(idempotencyKey);
return this;
}
@Override
protected GetRequest handleConflict(HttpClient httpClient, String id) {
CreditorBankAccountGetRequest request =
new CreditorBankAccountGetRequest(httpClient, id);
for (Map.Entry header : this.getCustomHeaders().entrySet()) {
request = request.withHeader(header.getKey(), header.getValue());
}
return request;
}
private CreditorBankAccountCreateRequest(HttpClient httpClient) {
super(httpClient);
}
public CreditorBankAccountCreateRequest withHeader(String headerName, String headerValue) {
this.addHeader(headerName, headerValue);
return this;
}
@Override
protected String getPathTemplate() {
return "creditor_bank_accounts";
}
@Override
protected String getEnvelope() {
return "creditor_bank_accounts";
}
@Override
protected Class getResponseClass() {
return CreditorBankAccount.class;
}
@Override
protected boolean hasBody() {
return true;
}
public enum AccountType {
@SerializedName("savings")
SAVINGS, @SerializedName("checking")
CHECKING, @SerializedName("unknown")
UNKNOWN;
@Override
public String toString() {
return name().toLowerCase();
}
}
public static class Links {
private String creditor;
/**
* ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
return this;
}
}
}
/**
* Request class for {@link CreditorBankAccountService#list }.
*
* Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank
* accounts.
*/
public static final class CreditorBankAccountListRequest
extends ListRequest {
private CreatedAt createdAt;
private String creditor;
private Boolean enabled;
/**
* Cursor pointing to the start of the desired set.
*/
public CreditorBankAccountListRequest withAfter(String after) {
setAfter(after);
return this;
}
/**
* Cursor pointing to the end of the desired set.
*/
public CreditorBankAccountListRequest withBefore(String before) {
setBefore(before);
return this;
}
public CreditorBankAccountListRequest withCreatedAt(CreatedAt createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Limit to records created after the specified date-time.
*/
public CreditorBankAccountListRequest withCreatedAtGt(String gt) {
if (createdAt == null) {
createdAt = new CreatedAt();
}
createdAt.withGt(gt);
return this;
}
/**
* Limit to records created on or after the specified date-time.
*/
public CreditorBankAccountListRequest withCreatedAtGte(String gte) {
if (createdAt == null) {
createdAt = new CreatedAt();
}
createdAt.withGte(gte);
return this;
}
/**
* Limit to records created before the specified date-time.
*/
public CreditorBankAccountListRequest withCreatedAtLt(String lt) {
if (createdAt == null) {
createdAt = new CreatedAt();
}
createdAt.withLt(lt);
return this;
}
/**
* Limit to records created on or before the specified date-time.
*/
public CreditorBankAccountListRequest withCreatedAtLte(String lte) {
if (createdAt == null) {
createdAt = new CreatedAt();
}
createdAt.withLte(lte);
return this;
}
/**
* Unique identifier, beginning with "CR".
*/
public CreditorBankAccountListRequest withCreditor(String creditor) {
this.creditor = creditor;
return this;
}
/**
* If `true`, only return enabled bank accounts. If `false`, only return disabled bank
* accounts.
*/
public CreditorBankAccountListRequest withEnabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Number of records to return.
*/
public CreditorBankAccountListRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
private CreditorBankAccountListRequest(HttpClient httpClient,
ListRequestExecutor executor) {
super(httpClient, executor);
}
public CreditorBankAccountListRequest withHeader(String headerName, String headerValue) {
this.addHeader(headerName, headerValue);
return this;
}
@Override
protected Map getQueryParams() {
ImmutableMap.Builder params = ImmutableMap.builder();
params.putAll(super.getQueryParams());
if (createdAt != null) {
params.putAll(createdAt.getQueryParams());
}
if (creditor != null) {
params.put("creditor", creditor);
}
if (enabled != null) {
params.put("enabled", enabled);
}
return params.build();
}
@Override
protected String getPathTemplate() {
return "creditor_bank_accounts";
}
@Override
protected String getEnvelope() {
return "creditor_bank_accounts";
}
@Override
protected TypeToken> getTypeToken() {
return new TypeToken>() {};
}
public static class CreatedAt {
private String gt;
private String gte;
private String lt;
private String lte;
/**
* Limit to records created after the specified date-time.
*/
public CreatedAt withGt(String gt) {
this.gt = gt;
return this;
}
/**
* Limit to records created on or after the specified date-time.
*/
public CreatedAt withGte(String gte) {
this.gte = gte;
return this;
}
/**
* Limit to records created before the specified date-time.
*/
public CreatedAt withLt(String lt) {
this.lt = lt;
return this;
}
/**
* Limit to records created on or before the specified date-time.
*/
public CreatedAt withLte(String lte) {
this.lte = lte;
return this;
}
public Map getQueryParams() {
ImmutableMap.Builder params = ImmutableMap.builder();
if (gt != null) {
params.put("created_at[gt]", gt);
}
if (gte != null) {
params.put("created_at[gte]", gte);
}
if (lt != null) {
params.put("created_at[lt]", lt);
}
if (lte != null) {
params.put("created_at[lte]", lte);
}
return params.build();
}
}
}
/**
* Request class for {@link CreditorBankAccountService#get }.
*
* Retrieves the details of an existing creditor bank account.
*/
public static final class CreditorBankAccountGetRequest
extends GetRequest {
@PathParam
private final String identity;
private CreditorBankAccountGetRequest(HttpClient httpClient, String identity) {
super(httpClient);
this.identity = identity;
}
public CreditorBankAccountGetRequest withHeader(String headerName, String headerValue) {
this.addHeader(headerName, headerValue);
return this;
}
@Override
protected Map getPathParams() {
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("identity", identity);
return params.build();
}
@Override
protected String getPathTemplate() {
return "creditor_bank_accounts/:identity";
}
@Override
protected String getEnvelope() {
return "creditor_bank_accounts";
}
@Override
protected Class getResponseClass() {
return CreditorBankAccount.class;
}
}
/**
* Request class for {@link CreditorBankAccountService#disable }.
*
* 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.
*/
public static final class CreditorBankAccountDisableRequest
extends PostRequest {
@PathParam
private final String identity;
private CreditorBankAccountDisableRequest(HttpClient httpClient, String identity) {
super(httpClient);
this.identity = identity;
}
public CreditorBankAccountDisableRequest withHeader(String headerName, String headerValue) {
this.addHeader(headerName, headerValue);
return this;
}
@Override
protected Map getPathParams() {
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("identity", identity);
return params.build();
}
@Override
protected String getPathTemplate() {
return "creditor_bank_accounts/:identity/actions/disable";
}
@Override
protected String getEnvelope() {
return "creditor_bank_accounts";
}
@Override
protected Class getResponseClass() {
return CreditorBankAccount.class;
}
@Override
protected boolean hasBody() {
return false;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy