outcome=success on
* the redirect_uri. It is therefore recommended to wait for the relevant bank
* authorisation event, such as BANK_AUTHORISATION_AUTHORISED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_AUTHORISED,
* BANK_AUTHORISATION_DENIED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_DENIED,
* or BANK_AUTHORISATION_FAILED
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_FAILED
* in order to show the correct outcome to the user.
*
* The BillingRequestFlow ID will also be appended to the redirect_uri as query
@@ -144,8 +144,8 @@ private Links() {
private String institution;
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this authorisation was created.
*/
public String getBillingRequest() {
@@ -153,8 +153,8 @@ public String getBillingRequest() {
}
/**
- * ID of the institution
+ * ID of the
+ * institution
* against which this authorisation was created.
*/
public String getInstitution() {
diff --git a/src/main/java/com/gocardless/resources/BankDetailsLookup.java b/src/main/java/com/gocardless/resources/BankDetailsLookup.java
index ef51a995..1c197d5f 100644
--- a/src/main/java/com/gocardless/resources/BankDetailsLookup.java
+++ b/src/main/java/com/gocardless/resources/BankDetailsLookup.java
@@ -19,8 +19,7 @@ private BankDetailsLookup() {
private PayerNameVerificationResult payerNameVerificationResult;
/**
- * Array of
- * schemes
+ * Array of schemes
* supported for this bank account. This will be an empty array if the bank account is not
* reachable by any schemes.
*/
diff --git a/src/main/java/com/gocardless/resources/BillingRequest.java b/src/main/java/com/gocardless/resources/BillingRequest.java
index a2e5a22b..ce1786fa 100644
--- a/src/main/java/com/gocardless/resources/BillingRequest.java
+++ b/src/main/java/com/gocardless/resources/BillingRequest.java
@@ -11,7 +11,7 @@
* of required input might be additional customer billing details, while an action would be asking a
* customer to authorise a payment using their mobile banking app.
*
- * See Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
*
* Important: All properties associated with
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -626,9 +627,9 @@ public Integer getAmount() {
/**
* A future date on which the payment should be collected. If the date is before the
- * next_possible_charge_date on the mandate,
- * it will be automatically rolled forwards to that date.
+ * next_possible_charge_date on the
+ * mandate, it will
+ * be automatically rolled forwards to that date.
*/
public String getChargeDate() {
return chargeDate;
@@ -638,7 +639,7 @@ public String getChargeDate() {
* A human-readable description of the payment. This will be included in the
* notification email GoCardless sends to your customer if your organisation does not
* send its own notifications (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements).
*/
public String getDescription() {
@@ -651,7 +652,7 @@ public String getDescription() {
*
* Frequency of the payments you want to create, together with an array of payment amounts
* to be collected, with a specified start date for the first payment. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with schedule)
*/
public static class InstalmentsWithSchedule {
@@ -690,8 +691,7 @@ public IntervalUnit getIntervalUnit() {
/**
* The date on which the first payment should be charged. Must be on or after the
- * mandate's
+ * mandate's
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -1377,9 +1376,9 @@ private Links() {
private String payment;
/**
- * (Optional) ID of the payment
- * that was created from this payment request.
+ * (Optional) ID of the
+ * payment that was
+ * created from this payment request.
*/
public String getPayment() {
return payment;
@@ -1455,7 +1454,7 @@ public String getCompanyName() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -1495,7 +1494,7 @@ public String getId() {
* ISO 639-1 code.
* Used as the language for notification emails sent by GoCardless if your organisation
* does not send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da",
* "nb", "sl", "sv" are supported. If this is not provided, the language will be chosen
* based on the
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -2022,8 +2021,8 @@ private Links() {
/**
* (Optional) ID of the subscription
- * that was created from this subscription request.
+ * "https://docs.gocardless.com/docs/api-reference/subscription">subscription that
+ * was created from this subscription request.
*/
public String getSubscription() {
return subscription;
diff --git a/src/main/java/com/gocardless/resources/BillingRequestFlow.java b/src/main/java/com/gocardless/resources/BillingRequestFlow.java
index 3c13acc9..3209ca63 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestFlow.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestFlow.java
@@ -204,8 +204,8 @@ private Links() {
private String billingRequest;
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this flow was created.
*/
public String getBillingRequest() {
@@ -230,7 +230,7 @@ private PrefilledBankAccount() {
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
diff --git a/src/main/java/com/gocardless/resources/BillingRequestTemplate.java b/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
index 0ecbad40..89026150 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
@@ -52,7 +52,7 @@ public String getAuthorisationUrl() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -185,7 +185,7 @@ public String getRedirectUri() {
/**
* Dynamic timestamp
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp
* recording when this resource was last updated.
*/
public String getUpdatedAt() {
diff --git a/src/main/java/com/gocardless/resources/BillingRequestWithAction.java b/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
index 8bda3919..e2d8c1a6 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
@@ -11,7 +11,7 @@
* of required input might be additional customer billing details, while an action would be asking a
* customer to authorise a payment using their mobile banking app.
*
- * See Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
*/
public class BillingRequestWithAction {
@@ -34,8 +34,7 @@ public BankAuthorisations getBankAuthorisations() {
* example of required input might be additional customer billing details, while an action would
* be asking a customer to authorise a payment using their mobile banking app.
*
- * See
- * Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
*
* Important: All properties associated with
* Important: All properties associated with
* Important: To be able to use intelligent retries, Success+ needs to
@@ -832,9 +830,9 @@ public Integer getAmount() {
/**
* A future date on which the payment should be collected. If the date is before the
- * next_possible_charge_date on the mandate,
- * it will be automatically rolled forwards to that date.
+ * next_possible_charge_date on the
+ * mandate, it
+ * will be automatically rolled forwards to that date.
*/
public String getChargeDate() {
return chargeDate;
@@ -844,7 +842,7 @@ public String getChargeDate() {
* A human-readable description of the payment. This will be included in the
* notification email GoCardless sends to your customer if your organisation does
* not send its own notifications (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements).
*/
public String getDescription() {
@@ -858,7 +856,7 @@ public String getDescription() {
* Frequency of the payments you want to create, together with an array of payment
* amounts to be collected, with a specified start date for the first payment. See
* create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with schedule)
*/
public static class InstalmentsWithSchedule {
@@ -897,8 +895,7 @@ public IntervalUnit getIntervalUnit() {
/**
* The date on which the first payment should be charged. Must be on or after the
- * mandate's
+ * mandate's
*
* Important: To be able to use intelligent retries, Success+ needs to
@@ -1593,9 +1590,9 @@ private Links() {
private String payment;
/**
- * (Optional) ID of the payment
- * that was created from this payment request.
+ * (Optional) ID of the
+ * payment that
+ * was created from this payment request.
*/
public String getPayment() {
return payment;
@@ -1671,7 +1668,7 @@ public String getCompanyName() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -1711,7 +1708,7 @@ public String getId() {
* ISO 639-1
* code. Used as the language for notification emails sent by GoCardless if your
* organisation does not send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da",
* "nb", "sl", "sv" are supported. If this is not provided, the language will be
* chosen based on the
* Important: To be able to use intelligent retries, Success+ needs to
@@ -2241,7 +2238,7 @@ private Links() {
/**
* (Optional) ID of the subscription
+ * "https://docs.gocardless.com/docs/api-reference/subscription">subscription
* that was created from this subscription request.
*/
public String getSubscription() {
diff --git a/src/main/java/com/gocardless/resources/Block.java b/src/main/java/com/gocardless/resources/Block.java
index 840ab626..528843de 100644
--- a/src/main/java/com/gocardless/resources/Block.java
+++ b/src/main/java/com/gocardless/resources/Block.java
@@ -64,7 +64,7 @@ public BlockType getBlockType() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -108,7 +108,7 @@ public String getResourceReference() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was updated.
*/
public String getUpdatedAt() {
diff --git a/src/main/java/com/gocardless/resources/Creditor.java b/src/main/java/com/gocardless/resources/Creditor.java
index dfb40350..515bff10 100644
--- a/src/main/java/com/gocardless/resources/Creditor.java
+++ b/src/main/java/com/gocardless/resources/Creditor.java
@@ -6,11 +6,10 @@
/**
* Represents a creditor resource returned from the API.
*
- * Each
- * payment
- * taken through the API is linked to a "creditor", to whom the payment is then paid out. In most
- * cases your organisation will have a single "creditor", but the API also supports collecting
- * payments on behalf of others.
+ * Each payment taken through
+ * the API is linked to a "creditor", to whom the payment is then paid out. In most cases your
+ * organisation will have a single "creditor", but the API also supports collecting payments on
+ * behalf of others.
*
* Currently, for Anti Money Laundering reasons, any creditors you add must be directly related to
* your organisation.
@@ -99,7 +98,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -153,9 +152,9 @@ public String getLogoUrl() {
}
/**
- * Boolean value indicating whether creditor has the Mandate
- * Imports functionality enabled.
+ * Boolean value indicating whether creditor has the
+ * Mandate Imports
+ * functionality enabled.
*/
public Boolean getMandateImportsEnabled() {
return mandateImportsEnabled;
@@ -164,9 +163,9 @@ public Boolean getMandateImportsEnabled() {
/**
* Boolean value indicating whether the organisation is responsible for sending all customer
* notifications (note this is separate from the functionality described here).
- * If you are a partner app, and this value is true, you should not send notifications on behalf
- * of this organisation.
+ * "https://docs.gocardless.com/docs/tutorials/handling-customer-notifications">here). If
+ * you are a partner app, and this value is true, you should not send notifications on behalf of
+ * this organisation.
*/
public Boolean getMerchantResponsibleForNotifications() {
return merchantResponsibleForNotifications;
@@ -198,8 +197,8 @@ public String getRegion() {
*
* The support address,
* Important: Events older than 18 months will be archived and no longer accessible
@@ -39,7 +39,7 @@ private Event() {
/**
* What has happened to the resource. See
- * Event Types for the
+ * Event Types for the
* possible actions.
*/
public String getAction() {
@@ -48,7 +48,7 @@ public String getAction() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -57,8 +57,8 @@ public String getCreatedAt() {
/**
* Present only in webhooks when an integrator is authorised to send their own notifications.
- * See here
+ * See
+ * here
* for further information.
*/
public List
@@ -62,7 +62,7 @@ private MandateImport() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -98,10 +98,10 @@ public Scheme getScheme() {
*
* Don't use Payer Authorisations for new integrations. It is deprecated in favour of
- * Billing
+ * Billing
* Requests. Use Billing Requests to build any future integrations.
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -254,8 +251,8 @@ public String getScheme() {
* the banks
*
* Deprecated: Redirect Flows are legacy APIs and cannot be used by new
- * integrators. The Billing
+ * integrators. The Billing
* Request flow API should be used for your payment flows.
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -244,8 +244,8 @@ public Boolean getRetryIfPossible() {
}
/**
- * The date on which the first payment should be charged. Must be on or after the mandate's
+ * The date on which the first payment should be charged. Must be on or after the
+ * mandate's
*
* Important: All properties associated with
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -341,9 +341,9 @@ public BillingRequestCreateRequest withLinks(Links links) {
}
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public BillingRequestCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -354,8 +354,7 @@ public BillingRequestCreateRequest withLinksCreditor(String creditor) {
}
/**
- * ID of the customer
+ * ID of the customer
* against which this request should be made.
*/
public BillingRequestCreateRequest withLinksCustomer(String customer) {
@@ -368,7 +367,7 @@ public BillingRequestCreateRequest withLinksCustomer(String customer) {
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* against which this request should be made.
*/
public BillingRequestCreateRequest withLinksCustomerBankAccount(
@@ -485,10 +484,10 @@ public BillingRequestCreateRequest withMandateRequestMetadata(
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public BillingRequestCreateRequest withMandateRequestReference(String reference) {
if (mandateRequest == null) {
@@ -548,7 +547,7 @@ public BillingRequestCreateRequest withMandateRequestSweeping(Boolean sweeping)
* preference.
*
* See Billing
+ * "https://docs.gocardless.com/docs/collect-payments/setting-up-mandates/verified-mandates">Billing
* Requests: Creating Verified Mandates for more information.
*/
public BillingRequestCreateRequest withMandateRequestVerify(MandateRequest.Verify verify) {
@@ -595,8 +594,8 @@ public BillingRequestCreateRequest withPaymentContextCode(
/**
* Specifies the underlying purpose of the payment. Defines the specific reason or type of
* service/goods the payment relates to, improving straight-through processing and
- * compliance. See
- * VRP
+ * compliance. See VRP
* Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public BillingRequestCreateRequest withPaymentPurposeCode(String paymentPurposeCode) {
@@ -704,9 +703,9 @@ public BillingRequestCreateRequest withPaymentRequestReference(String reference)
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -743,9 +742,9 @@ public BillingRequestCreateRequest withPaymentRequestScheme(String scheme) {
/**
* Specifies the high-level purpose/category of a mandate and/or payment using a set of
* pre-defined categories. Provides context on the nature and reason for the payment to
- * facilitate processing and compliance. See
- * Billing Request
- * Purpose Codes for the complete list of valid codes.
+ * facilitate processing and compliance. See Billing
+ * Request Purpose Codes for the complete list of valid codes.
*/
public BillingRequestCreateRequest withPurposeCode(PurposeCode purposeCode) {
this.purposeCode = purposeCode;
@@ -888,8 +887,8 @@ public BillingRequestCreateRequest withSubscriptionRequestName(String name) {
/**
* An optional payment reference. This will be set as the reference on each payment created
- * and will appear on your customer's bank statement. See the documentation for the create
+ * and will appear on your customer's bank statement. See the documentation for the
+ * create
* payment endpoint for more details.
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -1084,9 +1083,9 @@ public InstalmentsWithDates withAmount(Integer amount) {
/**
* A future date on which the payment should be collected. If the date is before the
- * next_possible_charge_date on the mandate,
- * it will be automatically rolled forwards to that date.
+ * next_possible_charge_date on the
+ * mandate, it will
+ * be automatically rolled forwards to that date.
*/
public InstalmentsWithDates withChargeDate(String chargeDate) {
this.chargeDate = chargeDate;
@@ -1097,7 +1096,7 @@ public InstalmentsWithDates withChargeDate(String chargeDate) {
* A human-readable description of the payment. This will be included in the
* notification email GoCardless sends to your customer if your organisation does not
* send its own notifications (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements).
*/
public InstalmentsWithDates withDescription(String description) {
@@ -1155,8 +1154,7 @@ public InstalmentsWithSchedule withIntervalUnit(IntervalUnit intervalUnit) {
/**
* The date on which the first payment should be charged. Must be on or after the
- * mandate's
+ * mandate's
*
* Important: To be able to use intelligent retries, Success+ needs to
@@ -1317,9 +1315,9 @@ public static class Links {
private String customerBankAccount;
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
@@ -1327,8 +1325,8 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of the customer
+ * ID of the
+ * customer
* against which this request should be made.
*/
public Links withCustomer(String customer) {
@@ -1338,7 +1336,7 @@ public Links withCustomer(String customer) {
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* against which this request should be made.
*/
public Links withCustomerBankAccount(String customerBankAccount) {
@@ -1634,8 +1632,8 @@ public MandateRequest withMetadata(Map
* Important: To be able to use intelligent retries, Success+ needs to
@@ -1980,7 +1978,7 @@ public SubscriptionRequest withName(String name) {
* An optional payment reference. This will be set as the reference on each payment
* created and will appear on your customer's bank statement. See the documentation for
* the create
+ * "https://docs.gocardless.com/docs/api-reference/payment#create-a-payment">create
* payment endpoint for more details.
* Important: To be able to use intelligent retries, Success+ needs to
@@ -2133,7 +2131,7 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerGivenName(String
* ISO 639-1 code. Used
* as the language for notification emails sent by GoCardless if your organisation does not
* send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb",
* "sl", "sv" are supported. If this is not provided and a customer was linked during
* billing request creation, the linked customer language will be used. Otherwise, the
@@ -2405,7 +2403,7 @@ public Customer withGivenName(String givenName) {
* ISO 639-1 code.
* Used as the language for notification emails sent by GoCardless if your organisation
* does not send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da",
* "nb", "sl", "sv" are supported. If this is not provided and a customer was linked
* during billing request creation, the linked customer language will be used.
@@ -2566,7 +2564,7 @@ public CustomerBillingDetail withSwedishIdentityNumber(String swedishIdentityNum
* relevant bank. If there is no match, the endpoint will return a 422 - validation error on
* account_holder_name: "Account holder name does not match bank account details provided".
* Testing instructions are here
+ * "https://docs.gocardless.com/docs/developer-resources/scenario-simulators#payer-name-verification">here
*/
public static final class BillingRequestCollectBankAccountRequest
extends PostRequest
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -552,9 +551,9 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestScheme
/**
* Specifies the high-level purpose/category of a mandate and/or payment using a set of
* pre-defined categories. Provides context on the nature and reason for the payment to
- * facilitate processing and compliance. See
- * Billing Request
- * Purpose Codes for the complete list of valid codes.
+ * facilitate processing and compliance. See Billing
+ * Request Purpose Codes for the complete list of valid codes.
*/
public BillingRequestWithActionCreateWithActionsRequest withPurposeCode(
PurposeCode purposeCode) {
@@ -691,7 +690,7 @@ public static class CollectBankAccount {
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public CollectBankAccount withAccountHolderName(String accountHolderName) {
@@ -700,8 +699,8 @@ public CollectBankAccount withAccountHolderName(String accountHolderName) {
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an
* Important: To be able to use intelligent retries, Success+ needs to
diff --git a/src/main/java/com/gocardless/services/BlockService.java b/src/main/java/com/gocardless/services/BlockService.java
index 72faec67..94aef582 100644
--- a/src/main/java/com/gocardless/services/BlockService.java
+++ b/src/main/java/com/gocardless/services/BlockService.java
@@ -64,7 +64,7 @@ public BlockGetRequest get(String identity) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your blocks.
*/
public BlockListRequest
* Important: Events older than 18 months will be archived and no longer accessible
@@ -38,7 +38,7 @@ public EventService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your events.
*
*
@@ -66,7 +66,7 @@ public EventGetRequest get(String identity) {
* Request class for {@link EventService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your events.
*
*
@@ -120,8 +120,7 @@ public EventListRequest
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -429,9 +429,9 @@ public Instalments withAmount(Integer amount) {
/**
* A future date on which the payment should be collected. If the date is before the
- * next_possible_charge_date on the mandate,
- * it will be automatically rolled forwards to that date.
+ * next_possible_charge_date on the
+ * mandate, it will
+ * be automatically rolled forwards to that date.
*/
public Instalments withChargeDate(String chargeDate) {
this.chargeDate = chargeDate;
@@ -442,7 +442,7 @@ public Instalments withChargeDate(String chargeDate) {
* A human-readable description of the payment. This will be included in the
* notification email GoCardless sends to your customer if your organisation does not
* send its own notifications (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements).
*/
public Instalments withDescription(String description) {
@@ -455,9 +455,9 @@ public static class Links {
private String mandate;
/**
- * ID of the associated mandate
- * which the instalment schedule will create payments against.
+ * ID of the associated
+ * mandate which
+ * the instalment schedule will create payments against.
*/
public Links withMandate(String mandate) {
this.mandate = mandate;
@@ -472,7 +472,7 @@ public Links withMandate(String mandate) {
* Creates a new instalment schedule object, along with the associated payments. This API is
* recommended if you wish to use the GoCardless scheduling logic. For finer control over the
* individual dates, please check out the alternative
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">alternative
* version.
*
* It can take quite a while to create the associated payments, so the API will return the
@@ -515,7 +515,7 @@ public InstalmentScheduleCreateWithScheduleRequest withCurrency(Currency currenc
/**
* Frequency of the payments you want to create, together with an array of payment amounts
* to be collected, with a specified start date for the first payment. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with schedule)
*/
public InstalmentScheduleCreateWithScheduleRequest withInstalments(
@@ -564,8 +564,8 @@ public InstalmentScheduleCreateWithScheduleRequest withInstalmentsIntervalUnit(
}
/**
- * The date on which the first payment should be charged. Must be on or after the mandate's
+ * The date on which the first payment should be charged. Must be on or after the
+ * mandate's
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -834,8 +834,7 @@ public Instalments withIntervalUnit(IntervalUnit intervalUnit) {
/**
* The date on which the first payment should be charged. Must be on or after the
- * mandate's
+ * mandate's
*
@@ -68,7 +68,7 @@ public MandateImportService(HttpClient httpClient) {
* Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint
* merely signals the start of the import process. Once you've finished adding entries to an
* import, you should submit
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import">submit
* it.
*/
public MandateImportCreateRequest create() {
@@ -109,7 +109,7 @@ public MandateImportCancelRequest cancel(String identity) {
* Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint
* merely signals the start of the import process. Once you've finished adding entries to an
* import, you should submit
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import">submit
* it.
*/
public static final class MandateImportCreateRequest
diff --git a/src/main/java/com/gocardless/services/MandatePdfService.java b/src/main/java/com/gocardless/services/MandatePdfService.java
index 79fc83b9..d1409d86 100644
--- a/src/main/java/com/gocardless/services/MandatePdfService.java
+++ b/src/main/java/com/gocardless/services/MandatePdfService.java
@@ -7,8 +7,8 @@
/**
* Service class for working with mandate pdf resources.
*
- * Mandate PDFs allow you to easily display scheme-rules
+ * Mandate PDFs allow you to easily display
+ * scheme-rules
* compliant Direct Debit mandates to your customers.
*/
public class MandatePdfService {
@@ -26,8 +26,8 @@ public MandatePdfService(HttpClient httpClient) {
* Generates a PDF mandate and returns its temporary URL.
*
* Customer and bank account details can be left blank (for a blank mandate), provided manually,
- * or inferred from the ID of an existing mandate.
+ * or inferred from the ID of an existing
+ * mandate.
*
* By default, we'll generate PDF mandates in English.
*
@@ -56,8 +56,8 @@ public MandatePdfCreateRequest create() {
* Generates a PDF mandate and returns its temporary URL.
*
* Customer and bank account details can be left blank (for a blank mandate), provided manually,
- * or inferred from the ID of an existing mandate.
+ * or inferred from the ID of an existing
+ * mandate.
*
* By default, we'll generate PDF mandates in English.
*
@@ -107,9 +107,8 @@ public static final class MandatePdfCreateRequest extends PostRequest
* Don't use Payer Authorisations for new integrations. It is deprecated in favour of
- * Billing
+ * Billing
* Requests. Use Billing Requests to build any future integrations.
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -421,9 +418,9 @@ public static class Links {
private String mandate;
/**
- * ID of the mandate
- * against which this payment should be collected.
+ * ID of the
+ * mandate against
+ * which this payment should be collected.
*/
public Links withMandate(String mandate) {
this.mandate = mandate;
@@ -436,7 +433,7 @@ public Links withMandate(String mandate) {
* Request class for {@link PaymentService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your payments.
*/
public static final class PaymentListRequest
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -1189,8 +1186,8 @@ public static final class PaymentRetryRequest extends PostRequest
* Deprecated: Redirect Flows are legacy APIs and cannot be used by new
- * integrators. The Billing
+ * integrators. The Billing
* Request flow API should be used for your payment flows.
*
@@ -132,8 +130,7 @@ public RefundCreateRequest withLinksMandate(String mandate) {
}
/**
- * ID of the payment
+ * ID of the payment
* against which the refund is being made.
*/
public RefundCreateRequest withLinksPayment(String payment) {
@@ -311,9 +308,9 @@ public static class Links {
private String payment;
/**
- * ID of the mandate
- * against which the refund is being made.
* Restricted: You must request access to Mandate Refunds by contacting
@@ -326,9 +323,9 @@ public Links withMandate(String mandate) {
}
/**
- * ID of the payment
- * against which the refund is being made.
+ * ID of the
+ * payment against
+ * which the refund is being made.
*/
public Links withPayment(String payment) {
this.payment = payment;
@@ -341,7 +338,7 @@ public Links withPayment(String payment) {
* Request class for {@link RefundService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your refunds.
*/
public static final class RefundListRequest
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -390,8 +390,8 @@ public SubscriptionCreateRequest withRetryIfPossible(Boolean retryIfPossible) {
}
/**
- * The date on which the first payment should be charged. Must be on or after the mandate's
+ * The date on which the first payment should be charged. Must be on or after the
+ * mandate's
*
* Important: To be able to use intelligent retries, Success+ needs to be
* enabled in GoCardless dashboard.
@@ -941,7 +941,7 @@ protected boolean hasBody() {
* subscription_request and
@@ -49,7 +49,7 @@ public Listamount
* and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public List
*
*/
@@ -572,9 +573,9 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this will
@@ -724,7 +724,7 @@ private Links() {
/**
* (Optional) ID of the instalment_schedule
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule">instalment_schedule
* that was created from this instalment schedule request.
*/
public String getInstalmentSchedule() {
@@ -760,8 +760,8 @@ private Links() {
private String subscriptionRequestSubscription;
/**
- * (Optional) ID of the bank
+ * (Optional) ID of the
+ * bank
* authorisation that was used to verify this request.
*/
public String getBankAuthorisation() {
@@ -769,16 +769,15 @@ public String getBankAuthorisation() {
}
/**
- * ID of the associated creditor.
+ * ID of the associated
+ * creditor.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of the customer
+ * ID of the customer
* that will be used for this request
*/
public String getCustomer() {
@@ -787,7 +786,7 @@ public String getCustomer() {
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* that will be used for this request
*/
public String getCustomerBankAccount() {
@@ -810,7 +809,7 @@ public String getInstalmentScheduleRequest() {
/**
* (Optional) ID of the instalment_schedule
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule">instalment_schedule
* that was created from this instalment schedule request.
*/
public String getInstalmentScheduleRequestInstalmentSchedule() {
@@ -825,9 +824,9 @@ public String getMandateRequest() {
}
/**
- * (Optional) ID of the mandate
- * that was created from this mandate request. this mandate request.
+ * (Optional) ID of the
+ * mandate that was
+ * created from this mandate request. this mandate request.
*/
public String getMandateRequestMandate() {
return mandateRequestMandate;
@@ -855,9 +854,9 @@ public String getPaymentRequest() {
}
/**
- * (Optional) ID of the payment
- * that was created from this payment request.
+ * (Optional) ID of the
+ * payment that was
+ * created from this payment request.
*/
public String getPaymentRequestPayment() {
return paymentRequestPayment;
@@ -871,8 +870,8 @@ public String getSubscriptionRequest() {
}
/**
- * (Optional) ID of the subscription
+ * (Optional) ID of the
+ * subscription
* that was created from this subscription request.
*/
public String getSubscriptionRequestSubscription() {
@@ -1028,7 +1027,7 @@ public Boolean getSweeping() {
* preference.
*
* See Billing
+ * "https://docs.gocardless.com/docs/collect-payments/setting-up-mandates/verified-mandates">Billing
* Requests: Creating Verified Mandates for more information.
*/
public Verify getVerify() {
@@ -1233,9 +1232,9 @@ private Links() {
private String mandate;
/**
- * (Optional) ID of the mandate
- * that was created from this mandate request. this mandate request.
+ * (Optional) ID of the
+ * mandate that was
+ * created from this mandate request. this mandate request.
*/
public String getMandate() {
return mandate;
@@ -1333,9 +1332,9 @@ public String getReference() {
}
/**
- * On failure, automatically retry the payment using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry the payment using intelligent
+ * retries. Default is false.
* country_code (if supplied) or default to "en".
@@ -1550,7 +1549,7 @@ private CustomerBankAccount() {
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public String getAccountHolderName() {
@@ -1568,7 +1567,7 @@ public String getAccountNumberEnding() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided
* for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
@@ -1602,7 +1601,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -1691,8 +1690,8 @@ private Links() {
private String customer;
/**
- * ID of the customer
+ * ID of the
+ * customer
* that owns this bank account.
*/
public String getCustomer() {
@@ -1764,7 +1763,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -1949,8 +1948,8 @@ public String getName() {
/**
* An optional payment reference. This will be set as the reference on each payment created
- * and will appear on your customer's bank statement. See the documentation for the create
+ * and will appear on your customer's bank statement. See the documentation for the
+ * create
* payment endpoint for more details.
*
*/
@@ -1959,9 +1958,9 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* subscription_request
@@ -76,7 +75,7 @@ public AuthorisationType getAuthorisationType() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when the user has been authorised.
*/
public String getAuthorisedAt() {
@@ -107,7 +106,7 @@ public String getId() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when the authorisation URL has been visited.
*/
public String getLastVisitedAt() {
@@ -140,11 +139,11 @@ public String getQrCodeUrl() {
* Please note: bank authorisations can still fail despite an outcome=success
* on the redirect_uri. It is therefore recommended to wait for the relevant
* bank authorisation event, such as BANK_AUTHORISATION_AUTHORISED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_AUTHORISED,
* BANK_AUTHORISATION_DENIED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_DENIED,
* or BANK_AUTHORISATION_FAILED
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_FAILED
* in order to show the correct outcome to the user.
*
* The BillingRequestFlow ID will also be appended to the redirect_uri as query
@@ -184,8 +183,8 @@ private Links() {
private String institution;
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this authorisation was created.
*/
public String getBillingRequest() {
@@ -193,8 +192,8 @@ public String getBillingRequest() {
}
/**
- * ID of the institution
+ * ID of the
+ * institution
* against which this authorisation was created.
*/
public String getInstitution() {
@@ -210,8 +209,7 @@ public String getInstitution() {
* example of required input might be additional customer billing details, while an action would
* be asking a customer to authorise a payment using their mobile banking app.
*
- * See
- * Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
* subscription_request
@@ -249,7 +247,7 @@ public Listamount and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public List
*
*/
@@ -777,8 +775,8 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using
- * intelligent
+ * On failure, automatically retry payments using intelligent
* retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this
@@ -931,7 +928,7 @@ private Links() {
/**
* (Optional) ID of the instalment_schedule
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule">instalment_schedule
* that was created from this instalment schedule request.
*/
public String getInstalmentSchedule() {
@@ -967,8 +964,8 @@ private Links() {
private String subscriptionRequestSubscription;
/**
- * (Optional) ID of the bank
+ * (Optional) ID of the
+ * bank
* authorisation that was used to verify this request.
*/
public String getBankAuthorisation() {
@@ -976,17 +973,17 @@ public String getBankAuthorisation() {
}
/**
- * ID of the associated creditor.
+ * ID of the associated
+ * creditor.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of the customer
- * that will be used for this request
+ * ID of the
+ * customer that
+ * will be used for this request
*/
public String getCustomer() {
return customer;
@@ -994,7 +991,7 @@ public String getCustomer() {
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* that will be used for this request
*/
public String getCustomerBankAccount() {
@@ -1017,7 +1014,7 @@ public String getInstalmentScheduleRequest() {
/**
* (Optional) ID of the instalment_schedule
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule">instalment_schedule
* that was created from this instalment schedule request.
*/
public String getInstalmentScheduleRequestInstalmentSchedule() {
@@ -1032,9 +1029,9 @@ public String getMandateRequest() {
}
/**
- * (Optional) ID of the mandate
- * that was created from this mandate request. this mandate request.
+ * (Optional) ID of the
+ * mandate that was
+ * created from this mandate request. this mandate request.
*/
public String getMandateRequestMandate() {
return mandateRequestMandate;
@@ -1062,9 +1059,9 @@ public String getPaymentRequest() {
}
/**
- * (Optional) ID of the payment
- * that was created from this payment request.
+ * (Optional) ID of the
+ * payment that was
+ * created from this payment request.
*/
public String getPaymentRequestPayment() {
return paymentRequestPayment;
@@ -1079,8 +1076,8 @@ public String getSubscriptionRequest() {
/**
* (Optional) ID of the subscription
- * that was created from this subscription request.
+ * "https://docs.gocardless.com/docs/api-reference/subscription">subscription that
+ * was created from this subscription request.
*/
public String getSubscriptionRequestSubscription() {
return subscriptionRequestSubscription;
@@ -1239,7 +1236,7 @@ public Boolean getSweeping() {
* verification preference.
*
* See Billing
+ * "https://docs.gocardless.com/docs/collect-payments/setting-up-mandates/verified-mandates">Billing
* Requests: Creating Verified Mandates for more information.
*/
public Verify getVerify() {
@@ -1446,9 +1443,9 @@ private Links() {
private String mandate;
/**
- * (Optional) ID of the mandate
- * that was created from this mandate request. this mandate request.
+ * (Optional) ID of the
+ * mandate that
+ * was created from this mandate request. this mandate request.
*/
public String getMandate() {
return mandate;
@@ -1547,8 +1544,8 @@ public String getReference() {
}
/**
- * On failure, automatically retry the payment using
- * intelligent
+ * On failure, automatically retry the payment using intelligent
* retries. Default is false.
* country_code (if supplied) or default to "en".
@@ -1766,7 +1763,7 @@ private CustomerBankAccount() {
* customer is created is stored and is available via the API, but is
* transliterated, upcased, and truncated to 18 characters in bank submissions. This
* field is required unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public String getAccountHolderName() {
@@ -1784,7 +1781,7 @@ public String getAccountNumberEnding() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be
* provided for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
@@ -1818,7 +1815,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -1908,8 +1905,8 @@ private Links() {
/**
* ID of the customer
- * that owns this bank account.
+ * "https://docs.gocardless.com/docs/api-reference/customer">customer that
+ * owns this bank account.
*/
public String getCustomer() {
return customer;
@@ -1980,7 +1977,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -2168,7 +2165,7 @@ public String getName() {
* An optional payment reference. This will be set as the reference on each payment
* created and will appear on your customer's bank statement. See the documentation for
* the create
+ * "https://docs.gocardless.com/docs/api-reference/payment#create-a-payment">create
* payment endpoint for more details.
*
*/
@@ -2177,8 +2174,8 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using
- * intelligent
+ * On failure, automatically retry payments using intelligent
* retries. Default is false.
* phone_number and email fields are for
* customers to contact the merchant for support purposes. They must be displayed on the payment
- * page, please see our compliance
+ * page, please see our
+ * compliance
* requirements for more details.
*/
public List
@@ -279,8 +278,8 @@ private Links() {
private String defaultUsdPayoutAccount;
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in AUD.
*/
public String getDefaultAudPayoutAccount() {
@@ -288,8 +287,8 @@ public String getDefaultAudPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in CAD.
*/
public String getDefaultCadPayoutAccount() {
@@ -297,8 +296,8 @@ public String getDefaultCadPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in DKK.
*/
public String getDefaultDkkPayoutAccount() {
@@ -306,8 +305,8 @@ public String getDefaultDkkPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in EUR.
*/
public String getDefaultEurPayoutAccount() {
@@ -315,8 +314,8 @@ public String getDefaultEurPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in GBP.
*/
public String getDefaultGbpPayoutAccount() {
@@ -324,8 +323,8 @@ public String getDefaultGbpPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in NZD.
*/
public String getDefaultNzdPayoutAccount() {
@@ -333,8 +332,8 @@ public String getDefaultNzdPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in SEK.
*/
public String getDefaultSekPayoutAccount() {
@@ -342,8 +341,8 @@ public String getDefaultSekPayoutAccount() {
}
/**
- * ID of the bank
+ * ID of the
+ * bank
* account which is set up to receive payouts in USD.
*/
public String getDefaultUsdPayoutAccount() {
@@ -426,7 +425,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -459,7 +458,7 @@ public String getId() {
* customer, and the charge date of a payment using this scheme identifier.
*
* By default, GoCardless sends these notifications automatically. Please see our compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements for more details.
*/
public Integer getMinimumAdvanceNotice() {
diff --git a/src/main/java/com/gocardless/resources/CreditorBankAccount.java b/src/main/java/com/gocardless/resources/CreditorBankAccount.java
index ad2e4091..847e471d 100644
--- a/src/main/java/com/gocardless/resources/CreditorBankAccount.java
+++ b/src/main/java/com/gocardless/resources/CreditorBankAccount.java
@@ -7,10 +7,9 @@
* Represents a creditor bank account resource returned from the API.
*
* Creditor Bank Accounts hold the bank details of a
- * creditor.
- * These are the bank accounts which your
- * payouts will
- * be sent to.
+ * 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
@@ -41,9 +40,9 @@ private CreditorBankAccount() {
/**
* Name of the account holder, as known by the bank. Usually this is the same as the name stored
- * with the linked creditor. This
- * field will be transliterated, upcased and truncated to 18 characters.
+ * with the linked
+ * creditor. This field
+ * will be transliterated, upcased and truncated to 18 characters.
*/
public String getAccountHolderName() {
return accountHolderName;
@@ -60,7 +59,7 @@ public String getAccountNumberEnding() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
@@ -86,7 +85,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -164,8 +163,7 @@ private Links() {
private String creditor;
/**
- * ID of the creditor
+ * ID of the creditor
* that owns this bank account.
*/
public String getCreditor() {
diff --git a/src/main/java/com/gocardless/resources/Customer.java b/src/main/java/com/gocardless/resources/Customer.java
index 9a10b5d5..01985379 100644
--- a/src/main/java/com/gocardless/resources/Customer.java
+++ b/src/main/java/com/gocardless/resources/Customer.java
@@ -5,10 +5,10 @@
/**
* Represents a customer resource returned from the API.
*
- * Customer objects hold the contact details for a customer. A customer can have several customer
- * bank accounts, which in turn can have several Direct Debit
- * mandates.
+ * Customer objects hold the contact details for a customer. A customer can have several
+ * customer bank
+ * accounts, which in turn can have several Direct Debit
+ * mandates.
*/
public class Customer {
private Customer() {
@@ -84,7 +84,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -131,8 +131,8 @@ public String getId() {
/**
* ISO 639-1 code. Used as
* the language for notification emails sent by GoCardless if your organisation does not send
- * its own (see compliance
+ * its own (see
+ * compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl",
* "sv" are supported. If this is not provided, the language will be chosen based on the
* country_code (if supplied) or default to "en".
diff --git a/src/main/java/com/gocardless/resources/CustomerBankAccount.java b/src/main/java/com/gocardless/resources/CustomerBankAccount.java
index a5b40c7b..a7ef76ef 100644
--- a/src/main/java/com/gocardless/resources/CustomerBankAccount.java
+++ b/src/main/java/com/gocardless/resources/CustomerBankAccount.java
@@ -7,11 +7,10 @@
* Represents a customer bank account resource returned from the API.
*
* Customer Bank Accounts hold the bank details of a
- * customer.
- * They always belong to a
- * customer,
- * and may be linked to several Direct Debit
- * mandates.
+ * customer. They always
+ * belong to a customer, and
+ * may be linked to several Direct Debit
+ * mandates.
*
* Note that customer 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
@@ -19,7 +18,7 @@
* links[customer_bank_account] in the error response.
*
* Note: To ensure the customer's bank accounts are valid, verify them first using bank_details_lookups,
+ * "https://docs.gocardless.com/docs/api-reference/bank-details-lookup#perform-a-bank-details-lookup">bank_details_lookups,
* before proceeding with creating the accounts
*/
public class CustomerBankAccount {
@@ -47,7 +46,7 @@ private CustomerBankAccount() {
* created is stored and is available via the API, but is transliterated, upcased, and truncated
* to 18 characters in bank submissions. This field is required unless the request includes a
* customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public String getAccountHolderName() {
@@ -65,7 +64,7 @@ public String getAccountNumberEnding() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
@@ -99,7 +98,7 @@ public String getCountryCode() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -195,8 +194,7 @@ private Links() {
private String customer;
/**
- * ID of the customer
+ * ID of the customer
* that owns this bank account.
*/
public String getCustomer() {
diff --git a/src/main/java/com/gocardless/resources/CustomerNotification.java b/src/main/java/com/gocardless/resources/CustomerNotification.java
index 4ca6a6c3..7e8066ec 100644
--- a/src/main/java/com/gocardless/resources/CustomerNotification.java
+++ b/src/main/java/com/gocardless/resources/CustomerNotification.java
@@ -42,7 +42,7 @@ public ActionTaken getActionTaken() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this action was taken.
*/
public String getActionTakenAt() {
diff --git a/src/main/java/com/gocardless/resources/Event.java b/src/main/java/com/gocardless/resources/Event.java
index 68633d1d..853ab123 100644
--- a/src/main/java/com/gocardless/resources/Event.java
+++ b/src/main/java/com/gocardless/resources/Event.java
@@ -11,8 +11,8 @@
* example a payment which has been collected, or a mandate which has been transferred. Event
* creation is an asynchronous process, so it can take some time between an action occurring and its
* corresponding event getting included in API responses. See
- * here for a complete
- * list of event types.
+ * here for a complete list of
+ * event types.
*
* resource_type is creditor, this is the ID of the creditor
- * which has been updated.
+ * If resource_type is creditor, this is the ID of the
+ * creditor which has
+ * been updated.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of a customer.
+ * ID of a customer.
*/
public String getCustomer() {
return customer;
}
/**
- * ID of a customer
+ * ID of a
+ * customer
* bank account.
*/
public String getCustomerBankAccount() {
@@ -424,8 +421,7 @@ public String getCustomerBankAccount() {
/**
* If resource_type is instalment_schedule, this is the ID of the
- * instalment
+ * instalment
* schedule which has been updated.
*/
public String getInstalmentSchedule() {
@@ -433,9 +429,9 @@ public String getInstalmentSchedule() {
}
/**
- * If resource_type is mandates, this is the ID of the mandate
- * which has been updated.
+ * If resource_type is mandates, this is the ID of the
+ * mandate which has
+ * been updated.
*/
public String getMandate() {
return mandate;
@@ -450,17 +446,16 @@ public String getMandateRequest() {
/**
* If resource_type is billing_requests, this is the ID of the
- * mandate
- * which has been created.
+ * mandate which has
+ * been created.
*/
public String getMandateRequestMandate() {
return mandateRequestMandate;
}
/**
- * This is only included for mandate transfer events, when it is the ID of the customer
+ * 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.
*/
public String getNewCustomerBankAccount() {
@@ -468,9 +463,9 @@ public String getNewCustomerBankAccount() {
}
/**
- * This is only included for mandate replaced events, when it is the ID of the new mandate
- * that replaces the existing mandate.
+ * This is only included for mandate replaced events, when it is the ID of the new
+ * mandate that
+ * replaces the existing mandate.
*/
public String getNewMandate() {
return newMandate;
@@ -478,9 +473,9 @@ public String getNewMandate() {
/**
* If the event is included in a
- * webhook
- * to an OAuth
- * app, this is the ID of the account to which it belongs.
+ * webhook to an
+ * OAuth app,
+ * this is the ID of the account to which it belongs.
*/
public String getOrganisation() {
return organisation;
@@ -505,8 +500,8 @@ public String getParentEvent() {
}
/**
- * ID of a payer
+ * ID of a
+ * payer
* authorisation.
*/
public String getPayerAuthorisation() {
@@ -514,9 +509,9 @@ public String getPayerAuthorisation() {
}
/**
- * If resource_type is payments, this is the ID of the payment
- * which has been updated.
+ * If resource_type is payments, this is the ID of the
+ * payment which has
+ * been updated.
*/
public String getPayment() {
return payment;
@@ -532,26 +527,25 @@ public String getPaymentAccountTransaction() {
/**
* If resource_type is billing_requests, this is the ID of the
- * payment
- * which has been created for Pay by Bank.
+ * payment which has
+ * been created for Pay by Bank.
*/
public String getPaymentRequestPayment() {
return paymentRequestPayment;
}
/**
- * If resource_type is payouts, this is the ID of the payout which
- * has been updated.
+ * If resource_type is payouts, this is the ID of the
+ * payout which has been
+ * updated.
*/
public String getPayout() {
return payout;
}
/**
- * This is only included for mandate transfer events, when it is the ID of the customer
+ * 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.
*/
public String getPreviousCustomerBankAccount() {
@@ -559,9 +553,9 @@ public String getPreviousCustomerBankAccount() {
}
/**
- * If resource_type is refunds, this is the ID of the refund which
- * has been updated.
+ * If resource_type is refunds, this is the ID of the
+ * refund which has been
+ * updated.
*/
public String getRefund() {
return refund;
@@ -570,7 +564,7 @@ public String getRefund() {
/**
* If resource_type is scheme_identifiers, this is the ID of the
* scheme_identifier
+ * "https://docs.gocardless.com/docs/api-reference/scheme-identifier">scheme_identifier
* which has been updated.
*/
public String getSchemeIdentifier() {
@@ -579,8 +573,7 @@ public String getSchemeIdentifier() {
/**
* If resource_type is subscription, this is the ID of the
- * subscription
+ * subscription
* which has been updated.
*/
public String getSubscription() {
diff --git a/src/main/java/com/gocardless/resources/Export.java b/src/main/java/com/gocardless/resources/Export.java
index 56418c20..ac233b82 100644
--- a/src/main/java/com/gocardless/resources/Export.java
+++ b/src/main/java/com/gocardless/resources/Export.java
@@ -21,7 +21,7 @@ private Export() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
diff --git a/src/main/java/com/gocardless/resources/InstalmentSchedule.java b/src/main/java/com/gocardless/resources/InstalmentSchedule.java
index 0673dda3..087c81e4 100644
--- a/src/main/java/com/gocardless/resources/InstalmentSchedule.java
+++ b/src/main/java/com/gocardless/resources/InstalmentSchedule.java
@@ -35,7 +35,7 @@ private InstalmentSchedule() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -154,25 +154,25 @@ private Links() {
private List
*
* When you add entries to your mandate import, they are not turned into actual mandates until the
@@ -32,12 +32,12 @@
*
* We will issue a mandate_created webhook for each entry, which will be the same as
* the webhooks triggered when
- * creating a
+ * creating a
* mandate using the mandates API. Once these webhooks start arriving, any reconciliation can
* now be accomplished by checking
- * the current status of the mandate import and linking
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#get-a-mandate-import">checking the
+ * current status of the mandate import and linking
* up the mandates to your system.
*
*
*
created: A new mandate import.submitted: After the integrator has finished adding mandates and submitted
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import">submitted
* the import.cancelled: If the integrator cancelled
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#cancel-a-mandate-import">cancelled
* the mandate import.processing: Once a mandate import has been approved by a GoCardless team
* member it will be in this state while mandates are imported.
*
* We suggest you provide a record_identifier (which is unique within the context of a
* single mandate import) to help you to identify mandates that have been created once the import
* has been processed by GoCardless. You can list
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import-entry#list-all-mandate-import-entries">list
* the mandate import entries, match them up in your system using the
* record_identifier, and look at the links fields to find the mandate,
* customer and customer bank account that have been imported.
@@ -43,7 +43,7 @@ private MandateImportEntry() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -111,7 +111,7 @@ public String getMandate() {
/**
* The ID of the mandate import. This is returned when you create
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#create-a-new-mandate-import">create
* a Mandate Import.
*/
public String getMandateImport() {
diff --git a/src/main/java/com/gocardless/resources/MandatePdf.java b/src/main/java/com/gocardless/resources/MandatePdf.java
index 4ec8d812..5541c709 100644
--- a/src/main/java/com/gocardless/resources/MandatePdf.java
+++ b/src/main/java/com/gocardless/resources/MandatePdf.java
@@ -3,8 +3,8 @@
/**
* Represents a mandate pdf resource returned from the API.
*
- * Mandate PDFs allow you to easily display scheme-rules
+ * Mandate PDFs allow you to easily display
+ * scheme-rules
* compliant Direct Debit mandates to your customers.
*/
public class MandatePdf {
diff --git a/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java b/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
index 1f218606..5ae2b6d1 100644
--- a/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
+++ b/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
@@ -29,7 +29,7 @@ public Integer getBalanceLimit() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this limit was created.
*/
public String getCreatedAt() {
@@ -89,8 +89,7 @@ public String getCreatorUser() {
}
/**
- * ID of creditor
+ * ID of creditor
* which this limit relates to
*/
public String getCreditor() {
diff --git a/src/main/java/com/gocardless/resources/OutboundPayment.java b/src/main/java/com/gocardless/resources/OutboundPayment.java
index 9d680c17..4a88a19b 100644
--- a/src/main/java/com/gocardless/resources/OutboundPayment.java
+++ b/src/main/java/com/gocardless/resources/OutboundPayment.java
@@ -7,12 +7,12 @@
* Represents a outbound payment resource returned from the API.
*
* Outbound Payments represent payments sent from
- * creditors.
+ * creditors.
*
* GoCardless will notify you via a
- * webhook when the
- * status of the outbound payment changes.
+ * webhook when the status of
+ * the outbound payment
+ * changes.
*
* Rate limiting
Two rate limits apply to the Outbound Payments APIs:
*
@@ -52,7 +52,7 @@ public Integer getAmount() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when the outbound payment was created.
*/
public String getCreatedAt() {
@@ -138,21 +138,21 @@ public Scheme getScheme() {
*
*
*
verifying: The payment has been created
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#create-an-outbound-payment">created
* and the verification process has begun.pending_approval: The payment is awaiting approval.scheduled: The payment has passed verification & approval,
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment">approval,
* but processing has not yet begun.executing: The execution date has arrived and the payment has been placed in
* queue for processing.executed: The payment has been accepted by the scheme and is now on its way
* to the recipient.cancelled: The payment has been cancelled
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#cancel-an-outbound-payment">cancelled
* or was not approved
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment">approved
* on time.failed: The payment was not sent, usually due to an error while or after
* executing.
*
payer_authorisation_completed
- * webhook
- * (recommended)https://api.gocardless.com/events?payer_authorisation={id}&action=completediban.
*/
public String getAccountNumber() {
@@ -210,7 +209,7 @@ public String getAccountNumberEnding() {
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public String getAccountNumberSuffix() {
@@ -220,7 +219,7 @@ public String getAccountNumberSuffix() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public AccountType getAccountType() {
@@ -228,8 +227,8 @@ public AccountType getAccountType() {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public String getBankCode() {
@@ -244,8 +243,8 @@ public String getBankName() {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public String getBranchCode() {
@@ -271,11 +270,11 @@ public String getCurrency() {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public String getIban() {
@@ -301,8 +300,8 @@ public enum AccountType {
/**
* Represents a customer resource returned from the API.
*
- * All details required for the creation of a Customer.
+ * All details required for the creation of a
+ * Customer.
*/
public static class Customer {
private Customer() {
@@ -521,8 +520,8 @@ public String getMandate() {
/**
* Represents a mandate resource returned from the API.
*
- * All details required for the creation of a Mandate.
+ * All details required for the creation of a
+ * Mandate.
*/
public static class Mandate {
private Mandate() {
@@ -555,10 +554,10 @@ public String getPayerIpAddress() {
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public String getReference() {
return reference;
diff --git a/src/main/java/com/gocardless/resources/Payment.java b/src/main/java/com/gocardless/resources/Payment.java
index 16975428..f8c5304e 100644
--- a/src/main/java/com/gocardless/resources/Payment.java
+++ b/src/main/java/com/gocardless/resources/Payment.java
@@ -7,15 +7,13 @@
* Represents a payment resource returned from the API.
*
* Payment objects represent payments from a
- * customer
- * to a
- * creditor,
- * taken against a Direct Debit
- * mandate.
+ * customer to a
+ * creditor, taken against a
+ * Direct Debit mandate.
*
* GoCardless will notify you via a
- * webhook whenever
- * the state of a payment changes.
+ * webhook whenever the state
+ * of a payment changes.
*/
public class Payment {
private Payment() {
@@ -54,8 +52,7 @@ public Integer getAmount() {
}
/**
- * Amount refunded, in the
+ * Amount refunded, in the
* lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*/
public Integer getAmountRefunded() {
@@ -74,8 +71,8 @@ public Integer getAppFee() {
/**
* A future date on which the payment should be collected. If not specified, the payment will be
- * collected as soon as possible. If the value is before the mandate's
+ * collected as soon as possible. If the value is before the
+ * mandate's
* next_possible_charge_date creation will fail. If the value is not a working day
* it will be rolled forwards to the next available one.
*/
@@ -85,7 +82,7 @@ public String getChargeDate() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -103,8 +100,8 @@ public Currency getCurrency() {
/**
* A human-readable description of the payment. This will be included in the notification email
* GoCardless sends to your customer if your organisation does not send its own notifications
- * (see compliance
+ * (see
+ * compliance
* requirements).
*/
public String getDescription() {
@@ -223,9 +220,9 @@ public String getReference() {
}
/**
- * On failure, automatically retry the payment using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry the payment using intelligent
+ * retries. Default is false.
* submitted: the payment has been submitted to the banksconfirmed: the payment has been confirmed as collectedpaid_out: the payment has been included in a payoutpaid_out: the payment has been included in a
+ * payoutcancelled: the payment has been cancelledcustomer_approval_denied: the customer has denied approval for the payment.
* You should contact the customer directly
*
* Note: this property will only be present if this payment is part of an
@@ -399,8 +395,7 @@ public String getInstalmentSchedule() {
}
/**
- * ID of the mandate
+ * ID of the mandate
* against which this payment should be collected.
*/
public String getMandate() {
@@ -408,8 +403,7 @@ public String getMandate() {
}
/**
- * ID of payout which
+ * ID of payout which
* contains the funds from this payment.
*
* Note: this property will not be present until the payment has been successfully
@@ -420,8 +414,8 @@ public String getPayout() {
}
/**
- * ID of subscription
+ * ID of
+ * subscription
* from which this payment was created.
*
* Note: this property will only be present if this payment is part of a
diff --git a/src/main/java/com/gocardless/resources/PaymentAccount.java b/src/main/java/com/gocardless/resources/PaymentAccount.java
index 3a8d0bd9..daa436d7 100644
--- a/src/main/java/com/gocardless/resources/PaymentAccount.java
+++ b/src/main/java/com/gocardless/resources/PaymentAccount.java
@@ -3,9 +3,8 @@
/**
* Represents a payment account resource returned from the API.
*
- * Access the details of bank accounts provided for you by GoCardless that are used to fund Outbound
- * Payments.
+ * Access the details of bank accounts provided for you by GoCardless that are used to fund
+ * Outbound Payments.
*/
public class PaymentAccount {
private PaymentAccount() {
@@ -30,9 +29,9 @@ public Integer getAccountBalance() {
/**
* Name of the account holder, as known by the bank. Usually this is the same as the name stored
- * with the linked creditor. This
- * field will be transliterated, upcased and truncated to 18 characters.
+ * with the linked
+ * creditor. This field
+ * will be transliterated, upcased and truncated to 18 characters.
*/
public String getAccountHolderName() {
return accountHolderName;
@@ -85,8 +84,7 @@ private Links() {
private String creditor;
/**
- * ID of the creditor
+ * ID of the creditor
* that owns this bank account.
*/
public String getCreditor() {
diff --git a/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java b/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
index 32c2b8ad..c7421eb3 100644
--- a/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
+++ b/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
@@ -6,9 +6,8 @@
* Represents a payment account transaction resource returned from the API.
*
* Payment account transactions represent movements of funds on a given payment account. The payment
- * account is provisioned by GoCardless and is used to fund outbound
- * payments.
+ * account is provisioned by GoCardless and is used to fund
+ * outbound payments.
*/
public class PaymentAccountTransaction {
private PaymentAccountTransaction() {
@@ -125,7 +124,7 @@ private Links() {
/**
* ID of the outbound_payment
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment">outbound_payment
* linked to the transaction
*/
public String getOutboundPayment() {
@@ -140,8 +139,7 @@ public String getPaymentBankAccount() {
}
/**
- * ID of the payout
+ * ID of the payout
* linked to the transaction.
*/
public String getPayout() {
diff --git a/src/main/java/com/gocardless/resources/Payout.java b/src/main/java/com/gocardless/resources/Payout.java
index 17eed085..e11c2fc1 100644
--- a/src/main/java/com/gocardless/resources/Payout.java
+++ b/src/main/java/com/gocardless/resources/Payout.java
@@ -7,11 +7,11 @@
* Represents a payout resource returned from the API.
*
* Payouts represent transfers from GoCardless to a
- * creditor.
- * Each payout contains the funds collected from one or many
- * payments.
- * All the payments in a payout will have been collected in the same currency. Payouts are created
- * automatically after a payment has been successfully collected.
+ * creditor. Each payout
+ * contains the funds collected from one or many
+ * payments. All the payments
+ * in a payout will have been collected in the same currency. Payouts are created automatically
+ * after a payment has been successfully collected.
*/
public class Payout {
private Payout() {
@@ -54,7 +54,7 @@ public String getArrivalDate() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -258,17 +258,15 @@ private Links() {
private String creditorBankAccount;
/**
- * ID of creditor
- * who will receive this payout, i.e. the owner of the creditor_bank_account.
+ * ID of creditor who
+ * will receive this payout, i.e. the owner of the creditor_bank_account.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of bank
+ * ID of bank
* account which this will be sent to.
*/
public String getCreditorBankAccount() {
diff --git a/src/main/java/com/gocardless/resources/PayoutItem.java b/src/main/java/com/gocardless/resources/PayoutItem.java
index 46b8c57e..218972b5 100644
--- a/src/main/java/com/gocardless/resources/PayoutItem.java
+++ b/src/main/java/com/gocardless/resources/PayoutItem.java
@@ -207,7 +207,7 @@ public String getDestinationCurrency() {
* rate has been finalised.
*
* You can listen for the payout's tax_exchange_rates_confirmed
+ * "https://docs.gocardless.com/docs/api-reference/events/payout">tax_exchange_rates_confirmed
* webhook to know when the exchange rate has been finalised for all fees in the payout.
*/
public String getExchangeRate() {
diff --git a/src/main/java/com/gocardless/resources/RedirectFlow.java b/src/main/java/com/gocardless/resources/RedirectFlow.java
index 2ac3b6f4..5c3b9892 100644
--- a/src/main/java/com/gocardless/resources/RedirectFlow.java
+++ b/src/main/java/com/gocardless/resources/RedirectFlow.java
@@ -8,8 +8,7 @@
*
*
*
* Once you have completed
+ * "https://docs.gocardless.com/docs/api-reference/redirect-flow#complete-a-redirect-flow">completed
* the redirect flow via the API, you should display a confirmation page to your customer,
* confirming that their Direct Debit has been set up. You can build your own page, or redirect to
* the one we provide in the https://pay.gocardless.com/flow/RE123.success_redirect_url with redirect_flow_id=RE123 in the
* querystring.confirmation_url attribute of the redirect flow.
@@ -72,7 +68,7 @@ private RedirectFlow() {
* use your own page, that confirms in their chosen language that their Direct Debit has been
* set up successfully. Only returned once the customer has set up their mandate via the payment
* pages and the redirect flow has been completed,
+ * "https://docs.gocardless.com/docs/api-reference/redirect-flow#complete-a-redirect-flow">completed,
* and only available for 15 minutes from when you complete the redirect flow. The structure of
* this URL may change at any time, so you should read it directly from the API response.
*/
@@ -82,7 +78,7 @@ public String getConfirmationUrl() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -188,8 +184,7 @@ private Links() {
private String mandate;
/**
- * ID of billing
+ * ID of billing
* request that a redirect flow can create.
*
* Note: The redirect flow will only create a billing request in the event
@@ -200,18 +195,16 @@ public String getBillingRequest() {
}
/**
- * The creditor
- * for whom the mandate will be created. The name of the creditor will be
- * displayed on the payment page.
+ * The creditor for
+ * whom the mandate will be created. The name of the creditor will be displayed
+ * on the payment page.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of customer
+ * ID of customer
* created by this redirect flow.
*
* Note: this property will not be present until the redirect flow has been
@@ -222,8 +215,8 @@ public String getCustomer() {
}
/**
- * ID of customer
+ * ID of
+ * customer
* bank account created by this redirect flow.
*
* Note: this property will not be present until the redirect flow has been
@@ -234,8 +227,7 @@ public String getCustomerBankAccount() {
}
/**
- * ID of mandate
+ * ID of mandate
* created by this redirect flow.
*
* Note: this property will not be present until the redirect flow has been
diff --git a/src/main/java/com/gocardless/resources/Refund.java b/src/main/java/com/gocardless/resources/Refund.java
index fd2e0ba3..fce10d8f 100644
--- a/src/main/java/com/gocardless/resources/Refund.java
+++ b/src/main/java/com/gocardless/resources/Refund.java
@@ -7,13 +7,12 @@
* Represents a refund resource returned from the API.
*
* Refund objects represent (partial) refunds of a
- * payment
- * back to the
- * customer.
+ * payment back to the
+ * customer.
*
* GoCardless will notify you via a
- * webhook whenever
- * a refund is created, and will update the amount_refunded property of the payment.
+ * webhook whenever a refund
+ * is created, and will update the amount_refunded property of the payment.
*/
public class Refund {
private Refund() {
@@ -39,7 +38,7 @@ public Integer getAmount() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -48,8 +47,8 @@ public String getCreatedAt() {
/**
* ISO 4217 currency code.
- * This is set to the currency of the refund's payment.
+ * This is set to the currency of the refund's
+ * payment.
*/
public String getCurrency() {
return currency;
@@ -165,8 +164,8 @@ public String getReference() {
* pending_submission: the refund has been created, but not yet submitted to
* the bankssubmitted: the refund has been submitted to the bankspaid: the refund has been included in a payoutpaid: the refund has been included in a
+ * payoutcancelled: the refund has been cancelledbounced: the refund has failed to be paidfunds_returned: the refund has had its funds returnedRecurrence Rules
The following rules apply when specifying recurrence:
*
*
*
day_of_month and start_date are not provided
* start_date will be the
- * mandate's
+ * mandate's
* next_possible_charge_date and the subscription will then recur based on the
* interval & interval_unitmonth or day_of_month are present the following validations
@@ -102,7 +102,7 @@ public Integer getCount() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
@@ -217,7 +217,7 @@ public Boolean getParentPlanPaused() {
/**
* An optional payment reference. This will be set as the reference on each payment created and
* will appear on your customer's bank statement. See the documentation for the
- * create
+ * create
* payment endpoint for more details.
*
*
@@ -231,9 +231,9 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first payment. If
* created without month or day_of_month this will be set as the
@@ -331,9 +331,9 @@ private Links() {
private String mandate;
/**
- * ID of the associated mandate
- * which the subscription will create payments against.
+ * ID of the associated
+ * mandate which the
+ * subscription will create payments against.
*/
public String getMandate() {
return mandate;
diff --git a/src/main/java/com/gocardless/resources/TaxRate.java b/src/main/java/com/gocardless/resources/TaxRate.java
index bcc42683..83e90de0 100644
--- a/src/main/java/com/gocardless/resources/TaxRate.java
+++ b/src/main/java/com/gocardless/resources/TaxRate.java
@@ -5,9 +5,8 @@
*
* Tax rates from tax authority.
*
- * We also maintain a
- * static list of the
- * tax rates for each jurisdiction.
+ * We also maintain a static list
+ * of the tax rates for each jurisdiction.
*/
public class TaxRate {
private TaxRate() {
diff --git a/src/main/java/com/gocardless/resources/TransferredMandate.java b/src/main/java/com/gocardless/resources/TransferredMandate.java
index ceb170b7..0086304c 100644
--- a/src/main/java/com/gocardless/resources/TransferredMandate.java
+++ b/src/main/java/com/gocardless/resources/TransferredMandate.java
@@ -58,7 +58,7 @@ private Links() {
/**
* The ID of the updated customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
*/
public String getCustomerBankAccount() {
return customerBankAccount;
diff --git a/src/main/java/com/gocardless/resources/VerificationDetail.java b/src/main/java/com/gocardless/resources/VerificationDetail.java
index 0d6ab436..3e9461c6 100644
--- a/src/main/java/com/gocardless/resources/VerificationDetail.java
+++ b/src/main/java/com/gocardless/resources/VerificationDetail.java
@@ -196,8 +196,7 @@ private Links() {
private String creditor;
/**
- * ID of the creditor
+ * ID of the creditor
*/
public String getCreditor() {
return creditor;
diff --git a/src/main/java/com/gocardless/resources/Webhook.java b/src/main/java/com/gocardless/resources/Webhook.java
index 736efa20..766c07b9 100644
--- a/src/main/java/com/gocardless/resources/Webhook.java
+++ b/src/main/java/com/gocardless/resources/Webhook.java
@@ -28,7 +28,7 @@ private Webhook() {
/**
* Fixed timestamp,
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times">timestamp,
* recording when this resource was created.
*/
public String getCreatedAt() {
diff --git a/src/main/java/com/gocardless/services/BalanceService.java b/src/main/java/com/gocardless/services/BalanceService.java
index 7331575a..fcef312b 100644
--- a/src/main/java/com/gocardless/services/BalanceService.java
+++ b/src/main/java/com/gocardless/services/BalanceService.java
@@ -29,7 +29,7 @@ public BalanceService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of balances for a given creditor. This endpoint is rate limited to 60 requests per
* minute.
*/
@@ -45,7 +45,7 @@ public BalanceListRequest withBefore(String before) {
}
/**
- * ID of a creditor.
+ * ID of a creditor.
*/
public BalanceListRequest withCreditor(String creditor) {
this.creditor = creditor;
diff --git a/src/main/java/com/gocardless/services/BankAccountDetailService.java b/src/main/java/com/gocardless/services/BankAccountDetailService.java
index ae896368..5bae10c4 100644
--- a/src/main/java/com/gocardless/services/BankAccountDetailService.java
+++ b/src/main/java/com/gocardless/services/BankAccountDetailService.java
@@ -27,7 +27,7 @@ public BankAccountDetailService(HttpClient httpClient) {
* 7516.
*
* You must specify a Gc-Key-Id header when using this endpoint. See Public Key
+ * "https://docs.gocardless.com/docs/gc-embed/bank-details-access#public-key-setup">Public Key
* Setup for more details.
*/
public BankAccountDetailGetRequest get(String identity) {
@@ -41,7 +41,7 @@ public BankAccountDetailGetRequest get(String identity) {
* 7516.
*
* You must specify a Gc-Key-Id header when using this endpoint. See Public Key
+ * "https://docs.gocardless.com/docs/gc-embed/bank-details-access#public-key-setup">Public Key
* Setup for more details.
*/
public static final class BankAccountDetailGetRequest extends GetRequestoutcome=success
* on the redirect_uri. It is therefore recommended to wait for the relevant
* bank authorisation event, such as BANK_AUTHORISATION_AUTHORISED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_AUTHORISED,
* BANK_AUTHORISATION_DENIED,
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_DENIED,
* or BANK_AUTHORISATION_FAILED
+ * "https://docs.gocardless.com/docs/api-reference/events/billing-request">BANK_AUTHORISATION_FAILED
* in order to show the correct outcome to the user.
*
* The BillingRequestFlow ID will also be appended to the redirect_uri as query
@@ -145,8 +145,8 @@ public static class Links {
private String billingRequest;
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this authorisation was created.
*/
public Links withBillingRequest(String billingRequest) {
diff --git a/src/main/java/com/gocardless/services/BankDetailsLookupService.java b/src/main/java/com/gocardless/services/BankDetailsLookupService.java
index 44f82031..ceb0eb64 100644
--- a/src/main/java/com/gocardless/services/BankDetailsLookupService.java
+++ b/src/main/java/com/gocardless/services/BankDetailsLookupService.java
@@ -31,14 +31,14 @@ public BankDetailsLookupService(HttpClient httpClient) {
* holder name does not match bank account details provided".
*
* If your request returns an
- * error or the
- * available_debit_schemes attribute is an empty array, you will not be able to
+ * error or
+ * the available_debit_schemes attribute is an empty array, you will not be able to
* collect payments from the specified bank account. GoCardless may be able to collect payments
* from an account even if no bic is returned.
*
* Bank account details may be supplied using
- * local
- * details or an IBAN.
+ * local details
+ * or an IBAN.
*
* ACH scheme For compliance reasons, an extra validation step is done using a
* third-party provider to make sure the customer's bank account can accept Direct Debit. If a
@@ -65,14 +65,14 @@ public BankDetailsLookupCreateRequest create() {
* holder name does not match bank account details provided".
*
* If your request returns an
- * error or the
- * available_debit_schemes attribute is an empty array, you will not be able to
+ * error or
+ * the available_debit_schemes attribute is an empty array, you will not be able to
* collect payments from the specified bank account. GoCardless may be able to collect payments
* from an account even if no bic is returned.
*
* Bank account details may be supplied using
- * local
- * details or an IBAN.
+ * local details
+ * or an IBAN.
*
* ACH scheme For compliance reasons, an extra validation step is done using a
* third-party provider to make sure the customer's bank account can accept Direct Debit. If a
@@ -101,8 +101,8 @@ public BankDetailsLookupCreateRequest withAccountHolderName(String accountHolder
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankDetailsLookupCreateRequest withAccountNumber(String accountNumber) {
@@ -111,8 +111,8 @@ public BankDetailsLookupCreateRequest withAccountNumber(String accountNumber) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankDetailsLookupCreateRequest withBankCode(String bankCode) {
@@ -121,8 +121,8 @@ public BankDetailsLookupCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankDetailsLookupCreateRequest withBranchCode(String branchCode) {
@@ -141,8 +141,8 @@ public BankDetailsLookupCreateRequest withCountryCode(String countryCode) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details.
*/
public BankDetailsLookupCreateRequest withIban(String iban) {
diff --git a/src/main/java/com/gocardless/services/BillingRequestFlowService.java b/src/main/java/com/gocardless/services/BillingRequestFlowService.java
index 3b2f4128..de3dddc3 100644
--- a/src/main/java/com/gocardless/services/BillingRequestFlowService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestFlowService.java
@@ -104,8 +104,8 @@ public BillingRequestFlowCreateRequest withLinks(Links links) {
}
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this flow was created.
*/
public BillingRequestFlowCreateRequest withLinksBillingRequest(String billingRequest) {
@@ -167,7 +167,7 @@ public BillingRequestFlowCreateRequest withPrefilledBankAccount(
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public BillingRequestFlowCreateRequest withPrefilledBankAccountAccountType(
@@ -443,8 +443,8 @@ public static class Links {
private String billingRequest;
/**
- * ID of the billing
+ * ID of the
+ * billing
* request against which this flow was created.
*/
public Links withBillingRequest(String billingRequest) {
@@ -459,7 +459,7 @@ public static class PrefilledBankAccount {
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public PrefilledBankAccount withAccountType(AccountType accountType) {
diff --git a/src/main/java/com/gocardless/services/BillingRequestService.java b/src/main/java/com/gocardless/services/BillingRequestService.java
index 31232427..5fd152eb 100644
--- a/src/main/java/com/gocardless/services/BillingRequestService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestService.java
@@ -16,7 +16,7 @@
* of required input might be additional customer billing details, while an action would be asking a
* customer to authorise a payment using their mobile banking app.
*
- * See Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
* subscription_request and
@@ -80,7 +80,7 @@ public BillingRequestCollectCustomerDetailsRequest collectCustomerDetails(String
* relevant bank. If there is no match, the endpoint will return a 422 - validation error on
* account_holder_name: "Account holder name does not match bank account details provided".
* Testing instructions are here
+ * "https://docs.gocardless.com/docs/developer-resources/scenario-simulators#payer-name-verification">here
*/
public BillingRequestCollectBankAccountRequest collectBankAccount(String identity) {
return new BillingRequestCollectBankAccountRequest(httpClient, identity);
@@ -111,7 +111,7 @@ public BillingRequestCancelRequest cancel(String identity) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your billing requests.
*/
public BillingRequestListRequestamount
* and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public BillingRequestCreateRequest withInstalmentScheduleRequestInstalmentsWithDates(
@@ -249,7 +249,7 @@ public BillingRequestCreateRequest withInstalmentScheduleRequestInstalmentsWithD
/**
* Frequency of the payments you want to create, together with an array of payment amounts
* to be collected, with a specified start date for the first payment. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with schedule)
*/
public BillingRequestCreateRequest withInstalmentScheduleRequestInstalmentsWithSchedule(
@@ -288,8 +288,8 @@ public BillingRequestCreateRequest withInstalmentScheduleRequestName(String name
/**
* An optional payment reference. This will be set as the reference on each payment created
- * and will appear on your customer's bank statement. See the documentation for the create
+ * and will appear on your customer's bank statement. See the documentation for the
+ * create
* payment endpoint for more details.
*
*/
@@ -303,9 +303,9 @@ public BillingRequestCreateRequest withInstalmentScheduleRequestPaymentReference
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
*
*
*/
@@ -903,9 +902,9 @@ public BillingRequestCreateRequest withSubscriptionRequestPaymentReference(
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this will
@@ -1231,7 +1229,7 @@ public InstalmentScheduleRequest withCurrency(String currency) {
/**
* An explicit array of instalment payments, each specifying at least an
* amount and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public InstalmentScheduleRequest withInstalmentsWithDates(
@@ -1244,7 +1242,7 @@ public InstalmentScheduleRequest withInstalmentsWithDates(
* Frequency of the payments you want to create, together with an array of payment
* amounts to be collected, with a specified start date for the first payment. See
* create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with schedule)
*/
public InstalmentScheduleRequest withInstalmentsWithSchedule(
@@ -1275,7 +1273,7 @@ public InstalmentScheduleRequest withName(String name) {
* An optional payment reference. This will be set as the reference on each payment
* created and will appear on your customer's bank statement. See the documentation for
* the create
+ * "https://docs.gocardless.com/docs/api-reference/payment#create-a-payment">create
* payment endpoint for more details.
*
*/
@@ -1285,8 +1283,8 @@ public InstalmentScheduleRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using
- * intelligent
+ * On failure, automatically retry payments using intelligent
* retries. Default is false.
* false.
*
*
*/
@@ -1990,8 +1988,8 @@ public SubscriptionRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using
- * intelligent
+ * On failure, automatically retry payments using intelligent
* retries. Default is false.
* iban.
*/
public BillingRequestCollectBankAccountRequest withAccountNumber(String accountNumber) {
@@ -2610,7 +2608,7 @@ public BillingRequestCollectBankAccountRequest withAccountNumber(String accountN
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public BillingRequestCollectBankAccountRequest withAccountNumberSuffix(
@@ -2622,7 +2620,7 @@ public BillingRequestCollectBankAccountRequest withAccountNumberSuffix(
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public BillingRequestCollectBankAccountRequest withAccountType(AccountType accountType) {
@@ -2631,8 +2629,8 @@ public BillingRequestCollectBankAccountRequest withAccountType(AccountType accou
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BillingRequestCollectBankAccountRequest withBankCode(String bankCode) {
@@ -2641,8 +2639,8 @@ public BillingRequestCollectBankAccountRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BillingRequestCollectBankAccountRequest withBranchCode(String branchCode) {
@@ -2671,11 +2669,11 @@ public BillingRequestCollectBankAccountRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public BillingRequestCollectBankAccountRequest withIban(String iban) {
@@ -3013,7 +3011,7 @@ protected String getRequestEnvelope() {
* Request class for {@link BillingRequestService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your billing requests.
*/
public static final class BillingRequestListRequest extends ListRequest withBefore(String before) {
}
/**
- * ID of a customer.
+ * ID of a customer.
* If specified, this endpoint will return all requests for the given customer.
*/
public BillingRequestListRequest withCustomer(String customer) {
diff --git a/src/main/java/com/gocardless/services/BillingRequestTemplateService.java b/src/main/java/com/gocardless/services/BillingRequestTemplateService.java
index 1d6a9a75..6121c0c7 100644
--- a/src/main/java/com/gocardless/services/BillingRequestTemplateService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestTemplateService.java
@@ -37,7 +37,7 @@ public BillingRequestTemplateService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your Billing Request Templates.
*/
public BillingRequestTemplateListRequest
@@ -230,9 +230,9 @@ public BillingRequestTemplateCreateRequest withLinks(Links links) {
}
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public BillingRequestTemplateCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -550,9 +550,9 @@ public static class Links {
private String creditor;
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
diff --git a/src/main/java/com/gocardless/services/BillingRequestWithActionService.java b/src/main/java/com/gocardless/services/BillingRequestWithActionService.java
index aa362f5b..d189b62b 100644
--- a/src/main/java/com/gocardless/services/BillingRequestWithActionService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestWithActionService.java
@@ -15,7 +15,7 @@
* of required input might be additional customer billing details, while an action would be asking a
* customer to authorise a payment using their mobile banking app.
*
- * See Billing
+ * See Billing
* Requests: Overview for how-to's, explanations and tutorials.
*/
public class BillingRequestWithActionService {
@@ -131,7 +131,7 @@ public BillingRequestWithActionCreateWithActionsRequest withActionsSelectInstitu
* debit. Should not be set if GoCardless payment intelligence feature is used.
*
* See Billing
+ * "https://docs.gocardless.com/docs/optimise/retain-customers-with-fallbacks">Billing
* Requests: Retain customers with Fallbacks for more information.
*/
public BillingRequestWithActionCreateWithActionsRequest withFallbackEnabled(
@@ -146,9 +146,9 @@ public BillingRequestWithActionCreateWithActionsRequest withLinks(Links links) {
}
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public BillingRequestWithActionCreateWithActionsRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -159,8 +159,7 @@ public BillingRequestWithActionCreateWithActionsRequest withLinksCreditor(String
}
/**
- * ID of the customer
+ * ID of the customer
* against which this request should be made.
*/
public BillingRequestWithActionCreateWithActionsRequest withLinksCustomer(String customer) {
@@ -173,7 +172,7 @@ public BillingRequestWithActionCreateWithActionsRequest withLinksCustomer(String
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* against which this request should be made.
*/
public BillingRequestWithActionCreateWithActionsRequest withLinksCustomerBankAccount(
@@ -280,10 +279,10 @@ public BillingRequestWithActionCreateWithActionsRequest withMandateRequestMetada
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public BillingRequestWithActionCreateWithActionsRequest withMandateRequestReference(
String reference) {
@@ -346,7 +345,7 @@ public BillingRequestWithActionCreateWithActionsRequest withMandateRequestSweepi
* preference.
*
* See Billing
+ * "https://docs.gocardless.com/docs/collect-payments/setting-up-mandates/verified-mandates">Billing
* Requests: Creating Verified Mandates for more information.
*/
public BillingRequestWithActionCreateWithActionsRequest withMandateRequestVerify(
@@ -396,8 +395,8 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentContextCode(
/**
* Specifies the underlying purpose of the payment. Defines the specific reason or type of
* service/goods the payment relates to, improving straight-through processing and
- * compliance. See
- * VRP
+ * compliance. See VRP
* Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentPurposeCode(
@@ -512,9 +511,9 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestRefere
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* iban.
*/
public CollectBankAccount withAccountNumber(String accountNumber) {
@@ -711,7 +710,7 @@ public CollectBankAccount withAccountNumber(String accountNumber) {
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public CollectBankAccount withAccountNumberSuffix(String accountNumberSuffix) {
@@ -722,7 +721,7 @@ public CollectBankAccount withAccountNumberSuffix(String accountNumberSuffix) {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided
* for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public CollectBankAccount withAccountType(AccountType accountType) {
@@ -731,8 +730,8 @@ public CollectBankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CollectBankAccount withBankCode(String bankCode) {
@@ -741,8 +740,8 @@ public CollectBankAccount withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CollectBankAccount withBranchCode(String branchCode) {
@@ -772,11 +771,11 @@ public CollectBankAccount withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK -
* you must supply local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden">local
* details.
*/
public CollectBankAccount withIban(String iban) {
@@ -903,7 +902,7 @@ public Customer withGivenName(String givenName) {
* ISO 639-1 code.
* Used as the language for notification emails sent by GoCardless if your organisation
* does not send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da",
* "nb", "sl", "sv" are supported. If this is not provided and a customer was linked
* during billing request creation, the linked customer language will be used.
@@ -1256,9 +1255,9 @@ public static class Links {
private String customerBankAccount;
/**
- * ID of the associated creditor.
- * Only required if your account manages multiple creditors.
+ * ID of the associated
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
@@ -1266,8 +1265,8 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of the customer
+ * ID of the
+ * customer
* against which this request should be made.
*/
public Links withCustomer(String customer) {
@@ -1277,7 +1276,7 @@ public Links withCustomer(String customer) {
/**
* (Optional) ID of the customer_bank_account
+ * "https://docs.gocardless.com/docs/api-reference/customer-bank-account">customer_bank_account
* against which this request should be made.
*/
public Links withCustomerBankAccount(String customerBankAccount) {
@@ -1560,8 +1559,8 @@ public MandateRequest withMetadata(Mapfalse.
* extends ListRequestbank_account_exists error if you try to create a duplicate bank account. You may
@@ -48,7 +47,7 @@ public CreditorBankAccountCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your creditor bank accounts.
*/
public CreditorBankAccountListRequestiban.
*/
public CreditorBankAccountCreateRequest withAccountNumber(String accountNumber) {
@@ -124,7 +123,7 @@ public CreditorBankAccountCreateRequest withAccountNumber(String accountNumber)
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public CreditorBankAccountCreateRequest withAccountType(AccountType accountType) {
@@ -133,8 +132,8 @@ public CreditorBankAccountCreateRequest withAccountType(AccountType accountType)
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CreditorBankAccountCreateRequest withBankCode(String bankCode) {
@@ -143,8 +142,8 @@ public CreditorBankAccountCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CreditorBankAccountCreateRequest withBranchCode(String branchCode) {
@@ -173,11 +172,11 @@ public CreditorBankAccountCreateRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public CreditorBankAccountCreateRequest withIban(String iban) {
@@ -191,8 +190,7 @@ public CreditorBankAccountCreateRequest withLinks(Links links) {
}
/**
- * ID of the creditor
+ * ID of the creditor
* that owns this bank account.
*/
public CreditorBankAccountCreateRequest withLinksCreditor(String creditor) {
@@ -294,9 +292,9 @@ public static class Links {
private String creditor;
/**
- * ID of the creditor
- * that owns this bank account.
+ * ID of the
+ * creditor that
+ * owns this bank account.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
@@ -309,7 +307,7 @@ public Links withCreditor(String creditor) {
* Request class for {@link CreditorBankAccountService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your creditor bank accounts.
*/
public static final class CreditorBankAccountListRequest
diff --git a/src/main/java/com/gocardless/services/CreditorService.java b/src/main/java/com/gocardless/services/CreditorService.java
index cadb7b6e..629ca11e 100644
--- a/src/main/java/com/gocardless/services/CreditorService.java
+++ b/src/main/java/com/gocardless/services/CreditorService.java
@@ -12,11 +12,10 @@
/**
* Service class for working with creditor resources.
*
- * Each
- * payment
- * taken through the API is linked to a "creditor", to whom the payment is then paid out. In most
- * cases your organisation will have a single "creditor", but the API also supports collecting
- * payments on behalf of others.
+ * Each payment taken through
+ * the API is linked to a "creditor", to whom the payment is then paid out. In most cases your
+ * organisation will have a single "creditor", but the API also supports collecting payments on
+ * behalf of others.
*
* Currently, for Anti Money Laundering reasons, any creditors you add must be directly related to
* your organisation.
@@ -41,7 +40,7 @@ public CreditorCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your creditors.
*/
public CreditorListRequest extends ListRequest
diff --git a/src/main/java/com/gocardless/services/CustomerBankAccountService.java b/src/main/java/com/gocardless/services/CustomerBankAccountService.java
index f66055cd..c3758ae5 100644
--- a/src/main/java/com/gocardless/services/CustomerBankAccountService.java
+++ b/src/main/java/com/gocardless/services/CustomerBankAccountService.java
@@ -13,11 +13,10 @@
* Service class for working with customer bank account resources.
*
* Customer Bank Accounts hold the bank details of a
- * customer.
- * They always belong to a
- * customer,
- * and may be linked to several Direct Debit
- * mandates.
+ * customer. They always
+ * belong to a customer, and
+ * may be linked to several Direct Debit
+ * mandates.
*
* Note that customer 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
@@ -25,7 +24,7 @@
* links[customer_bank_account] in the error response.
*
* Note: To ensure the customer's bank accounts are valid, verify them first using bank_details_lookups,
+ * "https://docs.gocardless.com/docs/api-reference/bank-details-lookup#perform-a-bank-details-lookup">bank_details_lookups,
* before proceeding with creating the accounts
*/
public class CustomerBankAccountService {
@@ -46,17 +45,16 @@ public CustomerBankAccountService(HttpClient httpClient) {
* There are three different ways to supply bank account details:
*
*
- *
* For more information on the different fields required in each country, see
- * local
- * bank details.
+ * local bank
+ * details.
*/
public CustomerBankAccountCreateRequest create() {
return new CustomerBankAccountCreateRequest(httpClient);
@@ -64,7 +62,7 @@ public CustomerBankAccountCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your bank accounts.
*/
public CustomerBankAccountListRequest
- *
* For more information on the different fields required in each country, see
- * local
- * bank details.
+ * local bank
+ * details.
*/
public static final class CustomerBankAccountCreateRequest
extends IdempotentPostRequestiban.
*/
public CustomerBankAccountCreateRequest withAccountNumber(String accountNumber) {
@@ -163,7 +160,7 @@ public CustomerBankAccountCreateRequest withAccountNumber(String accountNumber)
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public CustomerBankAccountCreateRequest withAccountType(AccountType accountType) {
@@ -172,8 +169,8 @@ public CustomerBankAccountCreateRequest withAccountType(AccountType accountType)
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CustomerBankAccountCreateRequest withBankCode(String bankCode) {
@@ -182,8 +179,8 @@ public CustomerBankAccountCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public CustomerBankAccountCreateRequest withBranchCode(String branchCode) {
@@ -212,11 +209,11 @@ public CustomerBankAccountCreateRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public CustomerBankAccountCreateRequest withIban(String iban) {
@@ -230,8 +227,7 @@ public CustomerBankAccountCreateRequest withLinks(Links links) {
}
/**
- * ID of the customer
+ * ID of the customer
* that owns this bank account.
*/
public CustomerBankAccountCreateRequest withLinksCustomer(String customer) {
@@ -244,7 +240,7 @@ public CustomerBankAccountCreateRequest withLinksCustomer(String customer) {
/**
* ID of a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token to use in place of bank account parameters.
*/
public CustomerBankAccountCreateRequest withLinksCustomerBankAccountToken(
@@ -338,9 +334,9 @@ public static class Links {
private String customerBankAccountToken;
/**
- * ID of the customer
- * that owns this bank account.
+ * ID of the
+ * customer that
+ * owns this bank account.
*/
public Links withCustomer(String customer) {
this.customer = customer;
@@ -349,7 +345,7 @@ public Links withCustomer(String customer) {
/**
* ID of a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token to use in place of bank account parameters.
*/
public Links withCustomerBankAccountToken(String customerBankAccountToken) {
@@ -363,7 +359,7 @@ public Links withCustomerBankAccountToken(String customerBankAccountToken) {
* Request class for {@link CustomerBankAccountService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your bank accounts.
*/
public static final class CustomerBankAccountListRequest
diff --git a/src/main/java/com/gocardless/services/CustomerService.java b/src/main/java/com/gocardless/services/CustomerService.java
index 16253bc8..0f65dbdf 100644
--- a/src/main/java/com/gocardless/services/CustomerService.java
+++ b/src/main/java/com/gocardless/services/CustomerService.java
@@ -12,10 +12,10 @@
/**
* Service class for working with customer resources.
*
- * Customer objects hold the contact details for a customer. A customer can have several customer
- * bank accounts, which in turn can have several Direct Debit
- * mandates.
+ * Customer objects hold the contact details for a customer. A customer can have several
+ * customer bank
+ * accounts, which in turn can have several Direct Debit
+ * mandates.
*/
public class CustomerService {
private final HttpClient httpClient;
@@ -37,7 +37,7 @@ public CustomerCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your customers.
*/
public CustomerListRequestcountry_code (if supplied) or default to "en".
@@ -306,7 +306,7 @@ protected boolean hasBody() {
* Request class for {@link CustomerService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your customers.
*/
public static final class CustomerListRequest extends ListRequestcountry_code (if supplied) or default to "en".
diff --git a/src/main/java/com/gocardless/services/EventService.java b/src/main/java/com/gocardless/services/EventService.java
index 7ec1b3f5..44187462 100644
--- a/src/main/java/com/gocardless/services/EventService.java
+++ b/src/main/java/com/gocardless/services/EventService.java
@@ -15,8 +15,8 @@
* example a payment which has been collected, or a mandate which has been transferred. Event
* creation is an asynchronous process, so it can take some time between an action occurring and its
* corresponding event getting included in API responses. See
- * here for a complete
- * list of event types.
+ * here for a complete list of
+ * event types.
*
* withBefore(String before) {
}
/**
- * ID of a billing
+ * ID of a billing
* request. If specified, this endpoint will return all events for the given billing
* request.
*/
@@ -180,8 +179,7 @@ public EventListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of an creditor.
+ * ID of an creditor.
* If specified, this endpoint will return all events for the given creditor.
*/
public EventListRequest withCreditor(String creditor) {
@@ -207,8 +205,8 @@ public EventListRequest withInclude(Include include) {
}
/**
- * ID of an instalment
+ * ID of an
+ * instalment
* schedule. If specified, this endpoint will return all events for the given instalment
* schedule.
*/
@@ -226,8 +224,7 @@ public EventListRequest withLimit(Integer limit) {
}
/**
- * ID of a mandate. If
+ * ID of a mandate. If
* specified, this endpoint will return all events for the given mandate.
*/
public EventListRequest withMandate(String mandate) {
@@ -237,7 +234,7 @@ public EventListRequest withMandate(String mandate) {
/**
* ID of an outbound_payment.
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment">outbound_payment.
* If specified, this endpoint will return all events for the given payment.
*/
public EventListRequest withOutboundPayment(String outboundPayment) {
@@ -255,8 +252,8 @@ public EventListRequest withParentEvent(String parentEvent) {
}
/**
- * ID of a payer
+ * ID of a
+ * payer
* authorisation.
*/
public EventListRequest withPayerAuthorisation(String payerAuthorisation) {
@@ -265,8 +262,7 @@ public EventListRequest withPayerAuthorisation(String payerAuthorisation) {
}
/**
- * ID of a payment. If
+ * ID of a payment. If
* specified, this endpoint will return all events for the given payment.
*/
public EventListRequest withPayment(String payment) {
@@ -284,8 +280,7 @@ public EventListRequest withPaymentAccountTransaction(String paymentAccountTr
}
/**
- * ID of a payout. If
+ * ID of a payout. If
* specified, this endpoint will return all events for the given payout.
*/
public EventListRequest withPayout(String payout) {
@@ -294,8 +289,7 @@ public EventListRequest withPayout(String payout) {
}
/**
- * ID of a refund. If
+ * ID of a refund. If
* specified, this endpoint will return all events for the given refund.
*/
public EventListRequest withRefund(String refund) {
@@ -317,8 +311,7 @@ public EventListRequest withResourceType(ResourceType resourceType) {
}
/**
- * ID of a scheme
+ * ID of a scheme
* identifier. If specified, this endpoint will return all events for the given scheme
* identifier.
*/
@@ -328,8 +321,8 @@ public EventListRequest withSchemeIdentifier(String schemeIdentifier) {
}
/**
- * ID of a subscription.
+ * ID of a
+ * subscription.
* If specified, this endpoint will return all events for the given subscription.
*/
public EventListRequest withSubscription(String subscription) {
diff --git a/src/main/java/com/gocardless/services/InstalmentScheduleService.java b/src/main/java/com/gocardless/services/InstalmentScheduleService.java
index e3fe4e6f..d5454bc6 100644
--- a/src/main/java/com/gocardless/services/InstalmentScheduleService.java
+++ b/src/main/java/com/gocardless/services/InstalmentScheduleService.java
@@ -41,7 +41,7 @@ public InstalmentScheduleService(HttpClient httpClient) {
* Creates a new instalment schedule object, along with the associated payments. This API is
* recommended if you know the specific dates you wish to charge. Otherwise, please check out
* the scheduling
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">scheduling
* version.
*
* The instalments property is an array of payment properties (amount
@@ -61,7 +61,7 @@ public InstalmentScheduleCreateWithDatesRequest createWithDates() {
* Creates a new instalment schedule object, along with the associated payments. This API is
* recommended if you wish to use the GoCardless scheduling logic. For finer control over the
* individual dates, please check out the alternative
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">alternative
* version.
*
* It can take quite a while to create the associated payments, so the API will return the
@@ -76,7 +76,7 @@ public InstalmentScheduleCreateWithScheduleRequest createWithSchedule() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your instalment schedules.
*/
public InstalmentScheduleListRequestinstalments property is an array of payment properties (amount
@@ -165,7 +165,7 @@ public InstalmentScheduleCreateWithDatesRequest withCurrency(Currency currency)
/**
* An explicit array of instalment payments, each specifying at least an amount
* and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public InstalmentScheduleCreateWithDatesRequest withInstalments(
@@ -177,7 +177,7 @@ public InstalmentScheduleCreateWithDatesRequest withInstalments(
/**
* An explicit array of instalment payments, each specifying at least an amount
* and charge_date. See create
+ * "https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule">create
* (with dates)
*/
public InstalmentScheduleCreateWithDatesRequest withInstalments(Instalments instalments) {
@@ -194,9 +194,9 @@ public InstalmentScheduleCreateWithDatesRequest withLinks(Links links) {
}
/**
- * ID of the associated mandate
- * which the instalment schedule will create payments against.
+ * ID of the associated
+ * mandate which the
+ * instalment schedule will create payments against.
*/
public InstalmentScheduleCreateWithDatesRequest withLinksMandate(String mandate) {
if (links == null) {
@@ -318,9 +318,9 @@ public InstalmentScheduleCreateWithDatesRequest withPaymentReference(
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this will be
@@ -586,9 +586,9 @@ public InstalmentScheduleCreateWithScheduleRequest withLinks(Links links) {
}
/**
- * ID of the associated mandate
- * which the instalment schedule will create payments against.
+ * ID of the associated
+ * mandate which the
+ * instalment schedule will create payments against.
*/
public InstalmentScheduleCreateWithScheduleRequest withLinksMandate(String mandate) {
if (links == null) {
@@ -711,9 +711,9 @@ public InstalmentScheduleCreateWithScheduleRequest withPaymentReference(
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this will
@@ -864,9 +863,9 @@ public static class Links {
private String mandate;
/**
- * ID of the associated mandate
- * which the instalment schedule will create payments against.
+ * ID of the associated
+ * mandate which
+ * the instalment schedule will create payments against.
*/
public Links withMandate(String mandate) {
this.mandate = mandate;
@@ -879,7 +878,7 @@ public Links withMandate(String mandate) {
* Request class for {@link InstalmentScheduleService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your instalment schedules.
*/
public static final class InstalmentScheduleListRequest
@@ -955,8 +954,8 @@ public InstalmentScheduleListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of the associated customer.
+ * ID of the associated
+ * customer.
*/
public InstalmentScheduleListRequest withCustomer(String customer) {
this.customer = customer;
@@ -972,9 +971,9 @@ public InstalmentScheduleListRequest withLimit(Integer limit) {
}
/**
- * ID of the associated mandate
- * which the instalment schedule will create payments against.
+ * ID of the associated
+ * mandate which the
+ * instalment schedule will create payments against.
*/
public InstalmentScheduleListRequest withMandate(String mandate) {
this.mandate = mandate;
diff --git a/src/main/java/com/gocardless/services/InstitutionService.java b/src/main/java/com/gocardless/services/InstitutionService.java
index 587c7b9a..3efb1537 100644
--- a/src/main/java/com/gocardless/services/InstitutionService.java
+++ b/src/main/java/com/gocardless/services/InstitutionService.java
@@ -12,8 +12,8 @@
/**
* Service class for working with institution resources.
*
- * Institutions that are supported when creating Bank
+ * Institutions that are supported when creating
+ * Bank
* Authorisations for a particular country or purpose.
*
* Not all institutions support both Payment Initiation (PIS) and Account Information (AIS)
diff --git a/src/main/java/com/gocardless/services/LogoService.java b/src/main/java/com/gocardless/services/LogoService.java
index 602197ef..4a9b04bb 100644
--- a/src/main/java/com/gocardless/services/LogoService.java
+++ b/src/main/java/com/gocardless/services/LogoService.java
@@ -6,9 +6,9 @@
/**
* Service class for working with logo resources.
*
- * Logos are image uploads that, when associated with a creditor, are shown on the billing
- * request flow payment pages.
+ * Logos are image uploads that, when associated with a creditor, are shown on the
+ * billing request
+ * flow payment pages.
*/
public class LogoService {
private final HttpClient httpClient;
@@ -28,7 +28,7 @@ public LogoService(HttpClient httpClient) {
* We support JPG and PNG formats. Your logo will be scaled to a maximum of 300px by 40px. For
* more guidance on how to upload logos that will look great across your customer payment page
* and notification emails see here.
+ * "https://docs.gocardless.com/docs/gc-embed/setting-up-branding#tips-for-uploading-your-logo">here.
*/
public LogoCreateForCreditorRequest createForCreditor() {
return new LogoCreateForCreditorRequest(httpClient);
@@ -43,7 +43,7 @@ public LogoCreateForCreditorRequest createForCreditor() {
* We support JPG and PNG formats. Your logo will be scaled to a maximum of 300px by 40px. For
* more guidance on how to upload logos that will look great across your customer payment page
* and notification emails see here.
+ * "https://docs.gocardless.com/docs/gc-embed/setting-up-branding#tips-for-uploading-your-logo">here.
*/
public static final class LogoCreateForCreditorRequest extends PostRequest
*
* We suggest you provide a record_identifier (which is unique within the context of a
* single mandate import) to help you to identify mandates that have been created once the import
* has been processed by GoCardless. You can list
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import-entry#list-all-mandate-import-entries">list
* the mandate import entries, match them up in your system using the
* record_identifier, and look at the links fields to find the mandate,
* customer and customer bank account that have been imported.
@@ -50,10 +50,9 @@ public MandateImportEntryService(HttpClient httpClient) {
}
/**
- * For an existing mandate
- * import, this endpoint can be used to add individual mandates to be imported into
- * GoCardless.
+ * For an existing
+ * mandate import,
+ * this endpoint can be used to add individual mandates to be imported into GoCardless.
*
* You can add no more than 30,000 rows to a single mandate import. If you attempt to go over
* this limit, the API will return a record_limit_exceeded error.
@@ -82,10 +81,9 @@ public MandateImportEntryListRequestrecord_limit_exceeded error.
@@ -152,7 +150,7 @@ public MandateImportEntryCreateRequest withBankAccount(BankAccount bankAccount)
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public MandateImportEntryCreateRequest withBankAccountAccountHolderName(
@@ -165,8 +163,8 @@ public MandateImportEntryCreateRequest withBankAccountAccountHolderName(
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountAccountNumber(String accountNumber) {
@@ -180,7 +178,7 @@ public MandateImportEntryCreateRequest withBankAccountAccountNumber(String accou
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public MandateImportEntryCreateRequest withBankAccountAccountType(
@@ -193,8 +191,8 @@ public MandateImportEntryCreateRequest withBankAccountAccountType(
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountBankCode(String bankCode) {
@@ -206,8 +204,8 @@ public MandateImportEntryCreateRequest withBankAccountBankCode(String bankCode)
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountBranchCode(String branchCode) {
@@ -233,11 +231,11 @@ public MandateImportEntryCreateRequest withBankAccountCountryCode(String country
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public MandateImportEntryCreateRequest withBankAccountIban(String iban) {
@@ -390,7 +388,7 @@ public MandateImportEntryCreateRequest withCustomerGivenName(String givenName) {
* ISO 639-1 code. Used
* as the language for notification emails sent by GoCardless if your organisation does not
* send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb",
* "sl", "sv" are supported. If this is not provided, the language will be chosen based on
* the country_code (if supplied) or default to "en".
@@ -518,10 +516,10 @@ public MandateImportEntryCreateRequest withMandateMetadata(Mapiban.
*/
public BankAccount withAccountNumber(String accountNumber) {
@@ -637,7 +635,7 @@ public BankAccount withAccountNumber(String accountNumber) {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided
* for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public BankAccount withAccountType(AccountType accountType) {
@@ -646,8 +644,8 @@ public BankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBankCode(String bankCode) {
@@ -656,8 +654,8 @@ public BankAccount withBankCode(String bankCode) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBranchCode(String branchCode) {
@@ -677,11 +675,11 @@ public BankAccount withCountryCode(String countryCode) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK -
* you must supply local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden">local
* details.
*/
public BankAccount withIban(String iban) {
@@ -822,7 +820,7 @@ public Customer withGivenName(String givenName) {
* ISO 639-1 code.
* Used as the language for notification emails sent by GoCardless if your organisation
* does not send its own (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da",
* "nb", "sl", "sv" are supported. If this is not provided, the language will be chosen
* based on the country_code (if supplied) or default to "en".
@@ -923,8 +921,8 @@ public Mandate withMetadata(Map
*
* When you add entries to your mandate import, they are not turned into actual mandates until the
@@ -36,12 +36,12 @@
*
* We will issue a mandate_created webhook for each entry, which will be the same as
* the webhooks triggered when
- * creating a
+ * creating a
* mandate using the mandates API. Once these webhooks start arriving, any reconciliation can
* now be accomplished by checking
- * the current status of the mandate import and linking
+ * "https://docs.gocardless.com/docs/api-reference/mandate-import#get-a-mandate-import">checking the
+ * current status of the mandate import and linking
* up the mandates to your system.
*
* iban.
*/
public MandatePdfCreateRequest withAccountNumber(String accountNumber) {
@@ -129,7 +128,7 @@ public MandatePdfCreateRequest withAccountNumber(String accountNumber) {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public MandatePdfCreateRequest withAccountType(AccountType accountType) {
@@ -162,8 +161,8 @@ public MandatePdfCreateRequest withAddressLine3(String addressLine3) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public MandatePdfCreateRequest withBankCode(String bankCode) {
@@ -172,8 +171,8 @@ public MandatePdfCreateRequest withBankCode(String bankCode) {
}
/**
- * SWIFT BIC. Will be derived automatically if a valid iban or local
+ * SWIFT BIC. Will be derived automatically if a valid iban or
+ * local
* details are provided.
*/
public MandatePdfCreateRequest withBic(String bic) {
@@ -182,8 +181,8 @@ public MandatePdfCreateRequest withBic(String bic) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public MandatePdfCreateRequest withBranchCode(String branchCode) {
@@ -246,8 +245,8 @@ public MandatePdfCreateRequest withGivenName(String givenName) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs cannot be provided for Autogiro mandates.
*/
public MandatePdfCreateRequest withIban(String iban) {
@@ -261,9 +260,9 @@ public MandatePdfCreateRequest withLinks(Links links) {
}
/**
- * ID of an existing creditor.
- * Only required if your account manages multiple creditors.
+ * ID of an existing
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public MandatePdfCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -274,10 +273,10 @@ public MandatePdfCreateRequest withLinksCreditor(String creditor) {
}
/**
- * ID of an existing mandate to
- * build the PDF from. The customer's bank details will be censored in the generated PDF. No
- * other parameters may be provided alongside this.
+ * ID of an existing
+ * mandate to build the
+ * PDF from. The customer's bank details will be censored in the generated PDF. No other
+ * parameters may be provided alongside this.
*/
public MandatePdfCreateRequest withLinksMandate(String mandate) {
if (links == null) {
@@ -334,8 +333,8 @@ public MandatePdfCreateRequest withRegion(String region) {
/**
* Direct Debit scheme. Can be supplied or automatically detected from the bank account
* details provided. If you do not provide a scheme, you must provide either a mandate, an
- * iban, or local
+ * iban, or
+ * local
* details including a country_code.
*/
public MandatePdfCreateRequest withScheme(String scheme) {
@@ -426,9 +425,9 @@ public static class Links {
private String mandate;
/**
- * ID of an existing creditor.
- * Only required if your account manages multiple creditors.
+ * ID of an existing
+ * creditor. Only
+ * required if your account manages multiple creditors.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
@@ -436,10 +435,10 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of an existing mandate
- * to build the PDF from. The customer's bank details will be censored in the generated
- * PDF. No other parameters may be provided alongside this.
+ * ID of an existing
+ * mandate to build
+ * the PDF from. The customer's bank details will be censored in the generated PDF. No
+ * other parameters may be provided alongside this.
*/
public Links withMandate(String mandate) {
this.mandate = mandate;
diff --git a/src/main/java/com/gocardless/services/MandateService.java b/src/main/java/com/gocardless/services/MandateService.java
index d15d554d..c4b7911d 100644
--- a/src/main/java/com/gocardless/services/MandateService.java
+++ b/src/main/java/com/gocardless/services/MandateService.java
@@ -15,11 +15,11 @@
* Service class for working with mandate resources.
*
* Mandates represent the Direct Debit mandate with a
- * customer.
+ * customer.
*
* GoCardless will notify you via a
- * webhook whenever
- * the status of a mandate changes.
+ * webhook whenever the status
+ * of a mandate changes.
*/
public class MandateService {
private final HttpClient httpClient;
@@ -41,7 +41,7 @@ public MandateCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your mandates.
*/
public MandateListRequest extends ListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of a creditor.
+ * ID of a creditor.
* If specified, this endpoint will return all mandates for the given creditor. Cannot be
* used in conjunction with customer or customer_bank_account
*/
@@ -385,8 +384,7 @@ public MandateListRequest withCreditor(String creditor) {
}
/**
- * ID of a customer.
+ * ID of a customer.
* If specified, this endpoint will return all mandates for the given customer. Cannot be
* used in conjunction with customer_bank_account or creditor
*/
@@ -396,8 +394,8 @@ public MandateListRequest withCustomer(String customer) {
}
/**
- * ID of a customer
+ * ID of a
+ * customer
* bank account. If specified, this endpoint will return all mandates for the given bank
* account. Cannot be used in conjunction with customer or
* creditor
@@ -445,10 +443,10 @@ public MandateListRequest withMandateType(String mandateType) {
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public MandateListRequest withReference(String reference) {
this.reference = reference;
diff --git a/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java b/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
index 161c26d2..3114aa3d 100644
--- a/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
+++ b/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
@@ -29,7 +29,7 @@ public NegativeBalanceLimitService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of negative balance limits.
*/
public NegativeBalanceLimitListRequest
diff --git a/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java b/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
index b558ff28..8b106092 100644
--- a/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
+++ b/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
@@ -27,7 +27,7 @@ public OutboundPaymentImportEntryService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of the entries for a given outbound payment import.
*/
public OutboundPaymentImportEntryListRequest
diff --git a/src/main/java/com/gocardless/services/OutboundPaymentImportService.java b/src/main/java/com/gocardless/services/OutboundPaymentImportService.java
index 4854f792..582994e3 100644
--- a/src/main/java/com/gocardless/services/OutboundPaymentImportService.java
+++ b/src/main/java/com/gocardless/services/OutboundPaymentImportService.java
@@ -60,7 +60,7 @@ public OutboundPaymentImportGetRequest get(String identity) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your outbound payment imports.
*/
public OutboundPaymentImportListRequest
diff --git a/src/main/java/com/gocardless/services/OutboundPaymentService.java b/src/main/java/com/gocardless/services/OutboundPaymentService.java
index 7a87eb1b..d8ab23fd 100644
--- a/src/main/java/com/gocardless/services/OutboundPaymentService.java
+++ b/src/main/java/com/gocardless/services/OutboundPaymentService.java
@@ -13,12 +13,12 @@
* Service class for working with outbound payment resources.
*
* Outbound Payments represent payments sent from
- * creditors.
+ * creditors.
*
* GoCardless will notify you via a
- * webhook when the
- * status of the outbound payment changes.
+ * webhook when the status of
+ * the outbound payment
+ * changes.
*
* Rate limiting
Two rate limits apply to the Outbound Payments APIs:
*
@@ -82,7 +82,7 @@ public OutboundPaymentGetRequest get(String identity) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of outbound payments.
*/
public OutboundPaymentListRequest
@@ -711,21 +711,21 @@ public OutboundPaymentListRequest withLimit(Integer limit) {
*
*
*
verifying: The payment has been created
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#create-an-outbound-payment">created
* and the verification process has begun.pending_approval: The payment is awaiting approval.scheduled: The payment has passed verification & approval,
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment">approval,
* but processing has not yet begun.executing: The execution date has arrived and the payment has been
* placed in queue for processing.executed: The payment has been accepted by the scheme and is now on its
* way to the recipient.cancelled: The payment has been cancelled
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#cancel-an-outbound-payment">cancelled
* or was not approved
+ * "https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment">approved
* on time.failed: The payment was not sent, usually due to an error while or after
* executing.
*
payer_authorisation_completed
- * webhook
- * (recommended)https://api.gocardless.com/events?payer_authorisation={id}&action=completediban.
*/
public PayerAuthorisationCreateRequest withBankAccountAccountNumber(String accountNumber) {
@@ -272,7 +266,7 @@ public PayerAuthorisationCreateRequest withBankAccountAccountNumberEnding(
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public PayerAuthorisationCreateRequest withBankAccountAccountNumberSuffix(
@@ -287,7 +281,7 @@ public PayerAuthorisationCreateRequest withBankAccountAccountNumberSuffix(
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public PayerAuthorisationCreateRequest withBankAccountAccountType(
@@ -300,8 +294,8 @@ public PayerAuthorisationCreateRequest withBankAccountAccountType(
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public PayerAuthorisationCreateRequest withBankAccountBankCode(String bankCode) {
@@ -324,8 +318,8 @@ public PayerAuthorisationCreateRequest withBankAccountBankName(String bankName)
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public PayerAuthorisationCreateRequest withBankAccountBranchCode(String branchCode) {
@@ -363,11 +357,11 @@ public PayerAuthorisationCreateRequest withBankAccountCurrency(String currency)
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public PayerAuthorisationCreateRequest withBankAccountIban(String iban) {
@@ -392,8 +386,8 @@ public PayerAuthorisationCreateRequest withBankAccountMetadata(
}
/**
- * All details required for the creation of a Customer.
+ * All details required for the creation of a
+ * Customer.
*/
public PayerAuthorisationCreateRequest withCustomer(Customer customer) {
this.customer = customer;
@@ -582,8 +576,8 @@ public PayerAuthorisationCreateRequest withCustomerSwedishIdentityNumber(
}
/**
- * All details required for the creation of a Mandate.
+ * All details required for the creation of a
+ * Mandate.
*/
public PayerAuthorisationCreateRequest withMandate(Mandate mandate) {
this.mandate = mandate;
@@ -619,10 +613,10 @@ public PayerAuthorisationCreateRequest withMandatePayerIpAddress(String payerIpA
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public PayerAuthorisationCreateRequest withMandateReference(String reference) {
if (mandate == null) {
@@ -706,7 +700,7 @@ public static class BankAccount {
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public BankAccount withAccountHolderName(String accountHolderName) {
@@ -715,8 +709,8 @@ public BankAccount withAccountHolderName(String accountHolderName) {
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withAccountNumber(String accountNumber) {
@@ -735,7 +729,7 @@ public BankAccount withAccountNumberEnding(String accountNumberEnding) {
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public BankAccount withAccountNumberSuffix(String accountNumberSuffix) {
@@ -746,7 +740,7 @@ public BankAccount withAccountNumberSuffix(String accountNumberSuffix) {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided
* for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public BankAccount withAccountType(AccountType accountType) {
@@ -755,8 +749,8 @@ public BankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBankCode(String bankCode) {
@@ -773,8 +767,8 @@ public BankAccount withBankName(String bankName) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBranchCode(String branchCode) {
@@ -804,11 +798,11 @@ public BankAccount withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK -
* you must supply local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden">local
* details.
*/
public BankAccount withIban(String iban) {
@@ -1020,8 +1014,8 @@ public Mandate withPayerIpAddress(String payerIpAddress) {
}
/**
- * Unique reference. Different schemes have different length and character
+ * Unique reference. Different schemes have different length and
+ * character
* set requirements. GoCardless will generate a unique reference satisfying the
* different scheme requirements if this field is left blank.
*/
@@ -1083,8 +1077,8 @@ public static final class PayerAuthorisationUpdateRequest
private Mandate mandate;
/**
- * All details required for the creation of a Customer
+ * All details required for the creation of a
+ * Customer
* Bank Account.
*/
public PayerAuthorisationUpdateRequest withBankAccount(BankAccount bankAccount) {
@@ -1097,7 +1091,7 @@ public PayerAuthorisationUpdateRequest withBankAccount(BankAccount bankAccount)
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public PayerAuthorisationUpdateRequest withBankAccountAccountHolderName(
@@ -1110,8 +1104,8 @@ public PayerAuthorisationUpdateRequest withBankAccountAccountHolderName(
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public PayerAuthorisationUpdateRequest withBankAccountAccountNumber(String accountNumber) {
@@ -1137,7 +1131,7 @@ public PayerAuthorisationUpdateRequest withBankAccountAccountNumberEnding(
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public PayerAuthorisationUpdateRequest withBankAccountAccountNumberSuffix(
@@ -1152,7 +1146,7 @@ public PayerAuthorisationUpdateRequest withBankAccountAccountNumberSuffix(
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
* bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public PayerAuthorisationUpdateRequest withBankAccountAccountType(
@@ -1165,8 +1159,8 @@ public PayerAuthorisationUpdateRequest withBankAccountAccountType(
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public PayerAuthorisationUpdateRequest withBankAccountBankCode(String bankCode) {
@@ -1189,8 +1183,8 @@ public PayerAuthorisationUpdateRequest withBankAccountBankName(String bankName)
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public PayerAuthorisationUpdateRequest withBankAccountBranchCode(String branchCode) {
@@ -1228,11 +1222,11 @@ public PayerAuthorisationUpdateRequest withBankAccountCurrency(String currency)
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you
* must supply
- * local
+ * local
* details.
*/
public PayerAuthorisationUpdateRequest withBankAccountIban(String iban) {
@@ -1257,8 +1251,8 @@ public PayerAuthorisationUpdateRequest withBankAccountMetadata(
}
/**
- * All details required for the creation of a Customer.
+ * All details required for the creation of a
+ * Customer.
*/
public PayerAuthorisationUpdateRequest withCustomer(Customer customer) {
this.customer = customer;
@@ -1447,8 +1441,8 @@ public PayerAuthorisationUpdateRequest withCustomerSwedishIdentityNumber(
}
/**
- * All details required for the creation of a Mandate.
+ * All details required for the creation of a
+ * Mandate.
*/
public PayerAuthorisationUpdateRequest withMandate(Mandate mandate) {
this.mandate = mandate;
@@ -1484,10 +1478,10 @@ public PayerAuthorisationUpdateRequest withMandatePayerIpAddress(String payerIpA
}
/**
- * Unique reference. Different schemes have different length and character
- * set requirements. GoCardless will generate a unique reference satisfying the
- * different scheme requirements if this field is left blank.
+ * Unique reference. Different schemes have different length and
+ * character set
+ * requirements. GoCardless will generate a unique reference satisfying the different scheme
+ * requirements if this field is left blank.
*/
public PayerAuthorisationUpdateRequest withMandateReference(String reference) {
if (mandate == null) {
@@ -1565,7 +1559,7 @@ public static class BankAccount {
* customer is created is stored and is available via the API, but is transliterated,
* upcased, and truncated to 18 characters in bank submissions. This field is required
* unless the request includes a customer
+ * "https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow">customer
* bank account token.
*/
public BankAccount withAccountHolderName(String accountHolderName) {
@@ -1574,8 +1568,8 @@ public BankAccount withAccountHolderName(String accountHolderName) {
}
/**
- * Bank account number - see local
+ * Bank account number - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withAccountNumber(String accountNumber) {
@@ -1594,7 +1588,7 @@ public BankAccount withAccountNumberEnding(String accountNumberEnding) {
/**
* Account number suffix (only for bank accounts denominated in NZD) - see local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand">local
* details for more information.
*/
public BankAccount withAccountNumberSuffix(String accountNumberSuffix) {
@@ -1605,7 +1599,7 @@ public BankAccount withAccountNumberSuffix(String accountNumberSuffix) {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided
* for bank accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public BankAccount withAccountType(AccountType accountType) {
@@ -1614,8 +1608,8 @@ public BankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see local
+ * Bank code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBankCode(String bankCode) {
@@ -1632,8 +1626,8 @@ public BankAccount withBankName(String bankName) {
}
/**
- * Branch code - see local
+ * Branch code - see
+ * local
* details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBranchCode(String branchCode) {
@@ -1663,11 +1657,11 @@ public BankAccount withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide local
+ * International Bank Account Number. Alternatively you can provide
+ * local
* details. IBANs are not accepted for Swedish bank accounts denominated in SEK -
* you must supply local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden">local
* details.
*/
public BankAccount withIban(String iban) {
@@ -1879,8 +1873,8 @@ public Mandate withPayerIpAddress(String payerIpAddress) {
}
/**
- * Unique reference. Different schemes have different length and character
+ * Unique reference. Different schemes have different length and
+ * character
* set requirements. GoCardless will generate a unique reference satisfying the
* different scheme requirements if this field is left blank.
*/
diff --git a/src/main/java/com/gocardless/services/PaymentAccountService.java b/src/main/java/com/gocardless/services/PaymentAccountService.java
index e8364051..2c5847db 100644
--- a/src/main/java/com/gocardless/services/PaymentAccountService.java
+++ b/src/main/java/com/gocardless/services/PaymentAccountService.java
@@ -10,9 +10,8 @@
/**
* Service class for working with payment account resources.
*
- * Access the details of bank accounts provided for you by GoCardless that are used to fund Outbound
- * Payments.
+ * Access the details of bank accounts provided for you by GoCardless that are used to fund
+ * Outbound Payments.
*/
public class PaymentAccountService {
private final HttpClient httpClient;
@@ -34,7 +33,7 @@ public PaymentAccountGetRequest get(String identity) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your payment accounts.
*/
public PaymentAccountListRequest extends ListRequestmandate_is_inactive error if the linked
- * mandate
- * is cancelled or has failed. Payments can be created against mandates with status of:
+ * mandate is cancelled or
+ * has failed. Payments can be created against mandates with status of:
* pending_customer_approval, pending_submission,
* submitted, and active.
*/
@@ -51,7 +49,7 @@ public PaymentCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your payments.
*/
public PaymentListRequestmandate_is_inactive error if the linked
- * mandate
- * is cancelled or has failed. Payments can be created against mandates with status of:
+ * mandate is cancelled or
+ * has failed. Payments can be created against mandates with status of:
* pending_customer_approval, pending_submission,
* submitted, and active.
*/
@@ -153,8 +151,8 @@ public PaymentCreateRequest withAppFee(Integer appFee) {
/**
* A future date on which the payment should be collected. If not specified, the payment
- * will be collected as soon as possible. If the value is before the mandate's
+ * will be collected as soon as possible. If the value is before the
+ * mandate's
* next_possible_charge_date creation will fail. If the value is not a working
* day it will be rolled forwards to the next available one.
*/
@@ -176,7 +174,7 @@ public PaymentCreateRequest withCurrency(Currency currency) {
* A human-readable description of the payment. This will be included in the notification
* email GoCardless sends to your customer if your organisation does not send its own
* notifications (see compliance
+ * "https://docs.gocardless.com/docs/api-reference/compliance-requirements">compliance
* requirements).
*/
public PaymentCreateRequest withDescription(String description) {
@@ -200,8 +198,7 @@ public PaymentCreateRequest withLinks(Links links) {
}
/**
- * ID of the mandate
+ * ID of the mandate
* against which this payment should be collected.
*/
public PaymentCreateRequest withLinksMandate(String mandate) {
@@ -331,9 +328,9 @@ public PaymentCreateRequest withReference(String reference) {
}
/**
- * On failure, automatically retry the payment using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry the payment using intelligent
+ * retries. Default is false.
* extends ListRequest withSortField(SortField sortField) {
* to the banks
* submitted: the payment has been submitted to the banksconfirmed: the payment has been confirmed as collectedpaid_out: the payment has been included in a payoutpaid_out: the payment has been included in a
+ * payoutcancelled: the payment has been cancelledcustomer_approval_denied: the customer has denied approval for the
* payment. You should contact the customer directlyfalse.
+ * On failure, automatically retry the payment using intelligent
+ * retries. Default is false.
* next_possible_charge_date creation will fail. If the value is not a working
* day it will be rolled forwards to the next available one.
*/
diff --git a/src/main/java/com/gocardless/services/PayoutItemService.java b/src/main/java/com/gocardless/services/PayoutItemService.java
index ddf3c959..d0d31f41 100644
--- a/src/main/java/com/gocardless/services/PayoutItemService.java
+++ b/src/main/java/com/gocardless/services/PayoutItemService.java
@@ -36,7 +36,7 @@ public PayoutItemService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of items in the payout.
*
* This endpoint only serves requests for payouts created in the last 6 months. Requests
@@ -54,7 +54,7 @@ public PayoutItemListRequest extends ListRequest
*
* Once you have completed
+ * "https://docs.gocardless.com/docs/api-reference/redirect-flow#complete-a-redirect-flow">completed
* the redirect flow via the API, you should display a confirmation page to your customer,
* confirming that their Direct Debit has been set up. You can build your own page, or redirect to
* the one we provide in the https://pay.gocardless.com/flow/RE123.success_redirect_url with redirect_flow_id=RE123 in the
* querystring.confirmation_url attribute of the redirect flow.
@@ -70,8 +66,8 @@ public RedirectFlowService(HttpClient httpClient) {
* GoCardless hosted payment pages.
*
* @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing
- * Request flow (https://developer.gocardless.com/api-reference/#billing-requests)
- * API should be used for your payment flows.
+ * Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API
+ * should be used for your payment flows.
*/
@Deprecated
public RedirectFlowCreateRequest create() {
@@ -82,8 +78,8 @@ public RedirectFlowCreateRequest create() {
* Returns all details about a single redirect flow
*
* @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing
- * Request flow (https://developer.gocardless.com/api-reference/#billing-requests)
- * API should be used for your payment flows.
+ * Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API
+ * should be used for your payment flows.
*/
@Deprecated
public RedirectFlowGetRequest get(String identity) {
@@ -91,12 +87,10 @@ public RedirectFlowGetRequest get(String identity) {
}
/**
- * This creates a customer,
- * customer
- * bank account, and
- * mandate
+ * This creates a
+ * customer,
+ * customer bank
+ * account, and mandate
* using the details supplied by your customer and returns the ID of the created mandate.
*
* This will return a redirect_flow_incomplete error if your customer has not yet
@@ -106,8 +100,8 @@ public RedirectFlowGetRequest get(String identity) {
* when the redirect flow was created.
*
* @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing
- * Request flow (https://developer.gocardless.com/api-reference/#billing-requests)
- * API should be used for your payment flows.
+ * Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API
+ * should be used for your payment flows.
*/
@Deprecated
public RedirectFlowCompleteRequest complete(String identity) {
@@ -146,10 +140,9 @@ public RedirectFlowCreateRequest withLinks(Links links) {
}
/**
- * The creditor
- * for whom the mandate will be created. The name of the creditor will be
- * displayed on the payment page. Required if your account manages multiple creditors.
+ * The creditor for
+ * whom the mandate will be created. The name of the creditor will be displayed
+ * on the payment page. Required if your account manages multiple creditors.
*/
public RedirectFlowCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -196,7 +189,7 @@ public RedirectFlowCreateRequest withPrefilledBankAccount(
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public RedirectFlowCreateRequest withPrefilledBankAccountAccountType(
@@ -484,8 +477,7 @@ public static class Links {
private String creditor;
/**
- * The creditor
+ * The creditor
* for whom the mandate will be created. The name of the creditor will be
* displayed on the payment page. Required if your account manages multiple creditors.
*/
@@ -501,7 +493,7 @@ public static class PrefilledBankAccount {
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
* accounts in other currencies. See local
+ * "https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states">local
* details for more information.
*/
public PrefilledBankAccount withAccountType(AccountType accountType) {
@@ -710,12 +702,10 @@ protected Classredirect_flow_incomplete error if your customer has not yet
diff --git a/src/main/java/com/gocardless/services/RefundService.java b/src/main/java/com/gocardless/services/RefundService.java
index 7bd7ba9e..ae835626 100644
--- a/src/main/java/com/gocardless/services/RefundService.java
+++ b/src/main/java/com/gocardless/services/RefundService.java
@@ -13,13 +13,12 @@
* Service class for working with refund resources.
*
* Refund objects represent (partial) refunds of a
- * payment
- * back to the
- * customer.
+ * payment back to the
+ * customer.
*
* GoCardless will notify you via a
- * webhook whenever
- * a refund is created, and will update the amount_refunded property of the payment.
+ * webhook whenever a refund
+ * is created, and will update the amount_refunded property of the payment.
*/
public class RefundService {
private final HttpClient httpClient;
@@ -52,7 +51,7 @@ public RefundCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your refunds.
*/
public RefundListRequest
*
*
+ * ID of the
+ * mandate against
+ * which the refund is being made.
*
* extends ListRequestRecurrence Rules
The following rules apply when specifying recurrence:
*
*
*
day_of_month and start_date are not provided
* start_date will be the
- * mandate's
+ * mandate's
* next_possible_charge_date and the subscription will then recur based on the
* interval & interval_unitmonth or day_of_month are present the following validations
@@ -77,7 +77,7 @@ public SubscriptionCreateRequest create() {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your subscriptions. Please note if the subscriptions are related to customers who
* have been removed, they will not be shown in the response.
*/
@@ -131,7 +131,7 @@ public SubscriptionUpdateRequest update(String identity) {
* end_date) or the subscription is already paused for a number of cycles.
*
* When pause_cycles is omitted the subscription is paused until the resume
+ * "https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription">resume
* endpoint is called. If the subscription is collecting a fixed number of payments,
* end_date will be set to null. When paused indefinitely,
* upcoming_payments will be empty.
@@ -307,9 +307,9 @@ public SubscriptionCreateRequest withLinks(Links links) {
}
/**
- * ID of the associated mandate
- * which the subscription will create payments against.
+ * ID of the associated
+ * mandate which the
+ * subscription will create payments against.
*/
public SubscriptionCreateRequest withLinksMandate(String mandate) {
if (links == null) {
@@ -360,8 +360,8 @@ public SubscriptionCreateRequest withName(String name) {
/**
* An optional payment reference. This will be set as the reference on each payment created
- * and will appear on your customer's bank statement. See the documentation for the create
+ * and will appear on your customer's bank statement. See the documentation for the
+ * create
* payment endpoint for more details.
*
*
@@ -376,9 +376,9 @@ public SubscriptionCreateRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* next_possible_charge_date. When left blank and month or
* day_of_month are provided, this will be set to the date of the first
* payment. If created without month or day_of_month this will be
@@ -484,9 +484,9 @@ public static class Links {
private String mandate;
/**
- * ID of the associated mandate
- * which the subscription will create payments against.
+ * ID of the associated
+ * mandate which
+ * the subscription will create payments against.
*/
public Links withMandate(String mandate) {
this.mandate = mandate;
@@ -499,7 +499,7 @@ public Links withMandate(String mandate) {
* Request class for {@link SubscriptionService#list }.
*
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of your subscriptions. Please note if the subscriptions are related to customers who
* have been removed, they will not be shown in the response.
*/
@@ -864,8 +864,8 @@ public SubscriptionUpdateRequest withName(String name) {
/**
* An optional payment reference. This will be set as the reference on each payment created
- * and will appear on your customer's bank statement. See the documentation for the create
+ * and will appear on your customer's bank statement. See the documentation for the
+ * create
* payment endpoint for more details.
*
*
@@ -880,9 +880,9 @@ public SubscriptionUpdateRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using
- * intelligent retries.
- * Default is false.
+ * On failure, automatically retry payments using intelligent
+ * retries. Default is false.
* end_date) or the subscription is already paused for a number of cycles.
*
* When pause_cycles is omitted the subscription is paused until the resume
+ * "https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription">resume
* endpoint is called. If the subscription is collecting a fixed number of payments,
* end_date will be set to null. When paused indefinitely,
* upcoming_payments will be empty.
@@ -1000,10 +1000,10 @@ public SubscriptionPauseRequest withMetadata(String key, String value) {
* interval and interval_unit. This should be a non zero positive
* value. For AUD subscriptions with interval_unit: weekly the minimum value
* varies between 3 & 4 because of the mandatory
+ * "https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription">mandatory
* minimum waiting period. For NZD subscriptions with interval_unit: weekly
* the minimum value is 2 because of the mandatory
+ * "https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription">mandatory
* minimum waiting period.
*/
public SubscriptionPauseRequest withPauseCycles(Integer pauseCycles) {
diff --git a/src/main/java/com/gocardless/services/TaxRateService.java b/src/main/java/com/gocardless/services/TaxRateService.java
index 2b11f72e..899e8a90 100644
--- a/src/main/java/com/gocardless/services/TaxRateService.java
+++ b/src/main/java/com/gocardless/services/TaxRateService.java
@@ -12,9 +12,8 @@
*
* Tax rates from tax authority.
*
- * We also maintain a
- * static list of the
- * tax rates for each jurisdiction.
+ * We also maintain a static list
+ * of the tax rates for each jurisdiction.
*/
public class TaxRateService {
private final HttpClient httpClient;
@@ -29,7 +28,7 @@ public TaxRateService(HttpClient httpClient) {
/**
* Returns a cursor-paginated
+ * "https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination">cursor-paginated
* list of all tax rates.
*/
public TaxRateListRequest extends ListRequest extends ListRequest