pending_payments_submitted: Payments we have submitted to the scheme but not
+ * yet confirmed. This does not exactly correspond to Pending payments in the dashboard,
* because this balance does not include payments that are pending submission.confirmed_funds: Payments that have been confirmed minus fees and unclaimed
+ * debits for refunds, failures and chargebacks. These funds have not yet been moved into a
+ * payout.pending_payouts: Confirmed payments that have been moved into a payout. This
+ * is the total due to be paid into your bank account in the next payout run (payouts happen
+ * once every business day). pending_payouts will only be non-zero while we are
+ * generating and submitting the payouts to our partner bank.alg: the asymmetric encryption type used to encrypt symmetric key, e.g:
+ * RSA-OAEP.enc: the content encryption type, e.g: A256GCM.kid: the ID of an RSA-2048 public key, from your JWKS, used to encrypt the
+ * AES key.full_match: The verification has confirmed that the account name exactly
+ * matches the details provided.partial_match: The verification has confirmed that the account name is
+ * similar but does not match to the details provided.no_match: The verification concludes the provided name does not match the
+ * account details.unable_to_match: The verification could not be performed due to recipient
+ * bank issues or technical issuespending: We have triggered the verification, but the result has not come
+ * back yet.completed: The verification is complete and is ready to be used.url to the payer to allow them to authorise with
+ * their mobile devices.
*/
public String getQrCodeUrl() {
return qrCodeUrl;
@@ -87,24 +90,27 @@ public String getQrCodeUrl() {
/**
* URL that the payer can be redirected to after authorising the payment.
*
- * On completion of bank authorisation, the query parameter of either `outcome=success` or
- * `outcome=failure` will be appended to the `redirect_uri` to indicate the result of the bank
- * authorisation. If the bank authorisation is expired, the query parameter `outcome=timeout`
- * will be appended to the `redirect_uri`, in which case you should prompt the user to try the
- * bank authorisation step again.
+ * On completion of bank authorisation, the query parameter of either
+ * outcome=success or outcome=failure will be appended to the
+ * redirect_uri to indicate the result of the bank authorisation. If the bank
+ * authorisation is expired, the query parameter outcome=timeout will be appended
+ * to the redirect_uri, in which case you should prompt the user to try the bank
+ * authorisation step again.
*
- * 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`](#billing-request-bankauthorisationauthorised),
- * [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or
- * [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in order to show the
- * correct outcome to the user.
+ * 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,
+ * BANK_AUTHORISATION_DENIED,
+ * or 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 parameter
- * `id=BRF123`.
+ * The BillingRequestFlow ID will also be appended to the redirect_uri as query
+ * parameter id=BRF123.
*
- * Defaults to `https://pay.gocardless.com/billing/static/thankyou`.
+ * Defaults to https://pay.gocardless.com/billing/static/thankyou.
*/
public String getRedirectUri() {
return redirectUri;
@@ -138,16 +144,18 @@ private Links() {
private String institution;
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this
- * authorisation was created.
+ * ID of the billing
+ * request against which this authorisation was created.
*/
public String getBillingRequest() {
return billingRequest;
}
/**
- * ID of the [institution](#billing-requests-institutions) against which this authorisation
- * was created.
+ * ID of the institution
+ * against which this authorisation was created.
*/
public String getInstitution() {
return institution;
diff --git a/src/main/java/com/gocardless/resources/BankDetailsLookup.java b/src/main/java/com/gocardless/resources/BankDetailsLookup.java
index f90ae46e..b58763cd 100644
--- a/src/main/java/com/gocardless/resources/BankDetailsLookup.java
+++ b/src/main/java/com/gocardless/resources/BankDetailsLookup.java
@@ -18,8 +18,10 @@ private BankDetailsLookup() {
private String bic;
/**
- * Array of [schemes](#mandates_scheme) supported for this bank account. This will be an empty
- * array if the bank account is not reachable by any 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.
*/
public List
* Even if no BIC is returned for an account, GoCardless may still be able to collect payments
- * from it - you should refer to the `available_debit_schemes` attribute to determine
+ * from it - you should refer to the available_debit_schemes attribute to determine
* reachability.
*
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with subscription_request and
+ * instalment_schedule_request are only supported for ACH and PAD schemes.
*
instalments_with_schedule object or an array of
+ * instalments_with_dates objects
*/
public InstalmentScheduleRequest getInstalmentScheduleRequest() {
return instalmentScheduleRequest;
@@ -121,9 +123,8 @@ public PaymentContextCode getPaymentContextCode() {
/**
* 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 Commercial Payment Purpose
- * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for the
- * complete list of valid codes.
+ * See VRP
+ * Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public String getPaymentPurposeCode() {
return paymentPurposeCode;
@@ -139,9 +140,9 @@ public PaymentRequest getPaymentRequest() {
/**
* 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](https://developer.gocardless.com/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 PurposeCode getPurposeCode() {
return purposeCode;
@@ -153,12 +154,13 @@ public Resources getResources() {
/**
* One of:
+ *
* pending: the billing request is pending and can be usedready_to_fulfil: the billing request is ready to fulfilfulfilling: the billing request is currently undergoing fulfilmentfulfilled: the billing request has been fulfilled and a payment createdcancelled: the billing request has been cancelled and cannot be usednot_needed: we won't attempt to infer the institution as it is not
+ * needed. Either because it was manually selected or the billing request does not support
+ * this featurepending: we are waiting on the bank details in order to infer the
+ * institutionfailed: we weren't able to infer the institutionsuccess: we inferred the institution and added it to the resources of a
+ * Billing Requestinstalments_with_schedule object or an array of
+ * instalments_with_dates objects
*/
public static class InstalmentScheduleRequest {
private InstalmentScheduleRequest() {
@@ -495,16 +504,18 @@ public Integer getAppFee() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "USD" and "CAD" are supported.
+ * ISO 4217 currency code.
+ * Currently "USD" and "CAD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * An explicit array of instalment payments, each specifying at least an `amount` and
- * `charge_date`. See [create (with dates)](#instalment-schedules-create-with-dates)
+ * An explicit array of instalment payments, each specifying at least an amount
+ * and charge_date. See create
+ * (with dates)
*/
public Listfalse.
* * Important: To be able to use intelligent retries, Success+ needs to be - * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). + * enabled in GoCardless dashboard. *
*/ public Boolean getRetryIfPossible() { @@ -588,6 +602,14 @@ private InstalmentsWithDate() { /** * Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in * EUR). + * + * Minimum and maximum amounts vary by payment scheme. For more information, see + * Transaction + * limits + * + * For Variable Recurring Payments (VRP), this must not exceed the mandate's + *max_amount_per_payment constraint.
*/
public Integer getAmount() {
return amount;
@@ -595,8 +617,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](#core-endpoints-mandates), 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;
@@ -605,8 +628,9 @@ 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
- * requirements](#appendix-compliance-requirements)).
+ * send its own notifications (see compliance
+ * requirements).
*/
public String getDescription() {
return description;
@@ -617,9 +641,9 @@ public String getDescription() {
* Represents a instalments with schedule resource returned from the API.
*
* 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 (with
- * schedule)](#instalment-schedules-create-with-schedule)
- *
+ * to be collected, with a specified start date for the first payment. See create
+ * (with schedule)
*/
public static class InstalmentsWithSchedule {
private InstalmentsWithSchedule() {
@@ -634,24 +658,22 @@ private InstalmentsWithSchedule() {
/**
* List of amounts of each instalment, in the lowest denomination for the currency (e.g.
* cents in USD).
- *
*/
public Listinterval_units between charge dates. Must be greater than or
+ * equal to 1.
*/
public Integer getInterval() {
return interval;
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public IntervalUnit getIntervalUnit() {
return intervalUnit;
@@ -659,10 +681,12 @@ public IntervalUnit getIntervalUnit() {
/**
* The date on which the first payment should be charged. Must be on or after the
- * [mandate](#core-endpoints-mandates)'s `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
- * mandate's `next_possible_charge_date`
+ * mandate's
+ * 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 mandate's next_possible_charge_date
*/
public String getStartDate() {
return startDate;
@@ -690,9 +714,9 @@ private Links() {
private String instalmentSchedule;
/**
- * (Optional) ID of the [instalment_schedule](#core-endpoints-instalment-schedules) that
- * was created from this instalment schedule request.
- *
+ * (Optional) ID of the instalment_schedule
+ * that was created from this instalment schedule request.
*/
public String getInstalmentSchedule() {
return instalmentSchedule;
@@ -727,30 +751,35 @@ private Links() {
private String subscriptionRequestSubscription;
/**
- * (Optional) ID of the [bank authorisation](#billing-requests-bank-authorisations) that was
- * used to verify this request.
+ * (Optional) ID of the bank
+ * authorisation that was used to verify this request.
*/
public String getBankAuthorisation() {
return bankAuthorisation;
}
/**
- * ID of the associated [creditor](#core-endpoints-creditors).
+ * ID of the associated creditor.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of the [customer](#core-endpoints-customers) that will be used for this request
+ * ID of the customer
+ * that will be used for this request
*/
public String getCustomer() {
return customer;
}
/**
- * (Optional) ID of the [customer_bank_account](#core-endpoints-customer-bank-accounts) that
- * will be used for this request
+ * (Optional) ID of the customer_bank_account
+ * that will be used for this request
*/
public String getCustomerBankAccount() {
return customerBankAccount;
@@ -771,8 +800,9 @@ public String getInstalmentScheduleRequest() {
}
/**
- * (Optional) ID of the [instalment_schedule](#core-endpoints-instalment-schedules) that was
- * created from this instalment schedule request.
+ * (Optional) ID of the instalment_schedule
+ * that was created from this instalment schedule request.
*/
public String getInstalmentScheduleRequestInstalmentSchedule() {
return instalmentScheduleRequestInstalmentSchedule;
@@ -786,8 +816,9 @@ public String getMandateRequest() {
}
/**
- * (Optional) ID of the [mandate](#core-endpoints-mandates) 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;
@@ -815,8 +846,9 @@ public String getPaymentRequest() {
}
/**
- * (Optional) ID of the [payment](#core-endpoints-payments) that was created from this
- * payment request.
+ * (Optional) ID of the payment
+ * that was created from this payment request.
*/
public String getPaymentRequestPayment() {
return paymentRequestPayment;
@@ -830,8 +862,9 @@ public String getSubscriptionRequest() {
}
/**
- * (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was created from
- * this subscription request.
+ * (Optional) ID of the subscription
+ * that was created from this subscription request.
*/
public String getSubscriptionRequestSubscription() {
return subscriptionRequestSubscription;
@@ -862,14 +895,13 @@ private MandateRequest() {
private Verify verify;
/**
- * This field is ACH specific, sometimes referred to as [SEC
- * code](https://www.moderntreasury.com/learn/sec-codes).
+ * This field is ACH specific, sometimes referred to as
+ * SEC code.
*
* This is the way that the payer gives authorisation to the merchant. web: Authorisation is
* Internet Initiated or via Mobile Entry (maps to SEC code: WEB) telephone: Authorisation
* is provided orally over telephone (maps to SEC code: TEL) paper: Authorisation is
* provided in writing and signed, or similarly authenticated (maps to SEC code: PPD)
- *
*/
public AuthorisationSource getAuthorisationSource() {
return authorisationSource;
@@ -877,9 +909,9 @@ public AuthorisationSource getAuthorisationSource() {
/**
* This attribute represents the authorisation type between the payer and merchant. It can
- * be set to `one_off`, `recurring` or `standing` for ACH scheme. And `single`, `recurring`
- * and `sporadic` for PAD scheme. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * be set to one_off, recurring or standing for ACH
+ * scheme. And single, recurring and sporadic for PAD
+ * scheme. Note: This is only supported for ACH and PAD schemes.
*/
public String getConsentType() {
return consentType;
@@ -894,7 +926,7 @@ public Constraints getConstraints() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+ * ISO 4217 currency code.
*/
public String getCurrency() {
return currency;
@@ -903,7 +935,6 @@ public String getCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public String getDescription() {
return description;
@@ -912,10 +943,12 @@ public String getDescription() {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct`
- * will be a direct transfer from the payer's account to the merchant where invoicing will
- * be handled separately.
- *
+ * managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.minimum: only verify if absolutely required, such as when part of scheme
+ * rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use themalways: as when_available, but fail to create the Billing
+ * Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer is
+ * fraudulent or not. The verification mechanism is based on the response and the payer may
+ * be asked to verify themselves. If the feature is not available, recommended
+ * behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified Mandates as
- * they are released in new schemes, please use the `minimum` verification preference.
+ * they are released in new schemes, please use the minimum verification
+ * preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public Verify getVerify() {
return verify;
@@ -1038,15 +1074,15 @@ private Constraints() {
* This is an optional field and if it is not supplied the agreement will be considered
* open and will not have an end date. Keep in mind the end date must take into account
* how long it will take the user to set up this agreement via the Billing Request.
- *
*/
public String getEndDate() {
return endDate;
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and
- * VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public Integer getMaxAmountPerPayment() {
return maxAmountPerPayment;
@@ -1054,15 +1090,20 @@ public Integer getMaxAmountPerPayment() {
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public String getPaymentMethod() {
return paymentMethod;
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public Listcreation_date if not
+ * specified.
*
- * `calendar` - this will finish on the end of the current period. For example this
- * will expire on the Monday for the current week or the January for the next year.
+ * calendar
+ * week runs Monday to Sunday, month runs from the 1st to
+ * the last day of the calendar month, and year runs from 1 January to
+ * 31 December. If the mandate starts partway through a period, the limit for that
+ * first period is reduced proportionally to the days remaining (e.g. a monthly
+ * limit starting on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period.
- * For example Monthly it will expire on the same day of the next month, or yearly
- * the same day of the next year.
+ * creation_date
+ * flexible.
*/
public Alignment getAlignment() {
return alignment;
@@ -1111,8 +1165,8 @@ public Alignment getAlignment() {
/**
* The maximum number of payments that can be collected in this periodic limit.
- * _Note:_ This is only supported for the PayTo scheme, where it is required.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public Integer getMaxPayments() {
return maxPayments;
@@ -1120,16 +1174,19 @@ public Integer getMaxPayments() {
/**
* The maximum total amount that can be charged for all payments in this periodic
- * limit. Required for VRP.
+ * limit, in the lowest denomination for the currency (e.g. pence in GBP, cents in
+ * EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public Integer getMaxTotalAmount() {
return maxTotalAmount;
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is
+ * provided (for both VRP and PayTo). If periodic_limits is omitted entirely for
+ * PayTo, this defaults to flexible.
*/
public Period getPeriod() {
return period;
@@ -1167,9 +1224,9 @@ private Links() {
private String mandate;
/**
- * (Optional) ID of the [mandate](#core-endpoints-mandates) 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;
@@ -1214,9 +1271,9 @@ public Integer getAppFee() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and
- * `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in
- * supported Eurozone countries only.
+ * ISO 4217 currency code.
+ * GBP and EUR supported; GBP with your customers in
+ * the UK and for EUR with your customers in supported Eurozone countries only.
*/
public String getCurrency() {
return currency;
@@ -1225,7 +1282,6 @@ public String getCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public String getDescription() {
return description;
@@ -1234,10 +1290,12 @@ public String getDescription() {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct`
- * will be a direct transfer from the payer's account to the merchant where invoicing will
- * be handled separately.
- *
+ * managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public String getScheme() {
return scheme;
@@ -1296,8 +1354,9 @@ private Links() {
private String payment;
/**
- * (Optional) ID of the [payment](#core-endpoints-payments) that was created from this
- * payment request.
+ * (Optional) ID of the payment
+ * that was created from this payment request.
*/
public String getPayment() {
return payment;
@@ -1361,18 +1420,20 @@ private Customer() {
private String phoneNumber;
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are
- * provided. For Canadian customers, the use of a `company_name` value will mean that
- * any mandate created from this customer will be considered to be a "Business PAD"
- * (otherwise, any mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered
+ * to be a "Personal PAD").
*/
public String getCompanyName() {
return companyName;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was
- * created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -1387,14 +1448,14 @@ public String getEmail() {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public String getFamilyName() {
return familyName;
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public String getGivenName() {
return givenName;
@@ -1408,12 +1469,13 @@ public String getId() {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not
- * send its own (see [compliance requirements](#appendix-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".
+ * ISO 639-1 code.
+ * Used as the language for notification emails sent by GoCardless if your organisation
+ * does not send 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".
*/
public String getLanguage() {
return language;
@@ -1428,8 +1490,8 @@ public Mapiban if
+ * supplied, otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was
- * created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency
+ * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
+ * supported.
*/
public String getCurrency() {
return currency;
@@ -1553,6 +1621,25 @@ public Mapfull: The name provided matches the name held by the bank.close: The name provided is a close but not exact match to the name
+ * held by the bank.cannot_perform_verification: A verification was attempted but could
+ * not be completed. This can happen for a number of reasons, including the account
+ * holder's bank not participating in the verification scheme, the account not being
+ * eligible for verification (e.g. the account holder has opted out), or the bank
+ * details not being resolvable, among others.authorisation_source is
+ * set to telephone or paper.
*/
public String getIpAddress() {
return ipAddress;
@@ -1686,8 +1784,8 @@ public String getPostalCode() {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required
- * (e.g. `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public String getRegion() {
return region;
@@ -1761,31 +1859,36 @@ public Integer getCount() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "USD" and "CAD" are supported.
+ * ISO 4217 currency code.
+ * Currently "USD" and "CAD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or `-1` to
- * indicate the last day of the month.
+ * As per RFC 2445. The day of the month to charge customers on. 1
+ * 28 or -1 to indicate the last day of the month.
*/
public Integer getDayOfMonth() {
return dayOfMonth;
}
/**
- * Number of `interval_units` between customer charge dates. Must be greater than or equal
- * to `1`. Must result in at least one charge date per year. Defaults to `1`.
+ * Number of interval_units between customer charge dates. Must be greater than
+ * or equal to 1. Must result in at least one charge date per year. Defaults to
+ * 1.
*/
public Integer getInterval() {
return interval;
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public IntervalUnit getIntervalUnit() {
return intervalUnit;
@@ -1805,8 +1908,7 @@ public Mapyearly.
*/
public Month getMonth() {
return month;
@@ -1822,19 +1924,22 @@ 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
- * payment endpoint](#payments-create-a-payment) for more details. false.
* * Important: To be able to use intelligent retries, Success+ needs to be - * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). + * enabled in GoCardless dashboard. *
*/ public Boolean getRetryIfPossible() { @@ -1843,11 +1948,11 @@ public Boolean getRetryIfPossible() { /** * The date on which the first payment should be charged. If fulfilled after this date, this - * will be set as the mandate's `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 mandate's - * `next_possible_charge_date`. - * + * will be set as the mandate'snext_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 mandate's
+ * next_possible_charge_date.
*/
public String getStartDate() {
return startDate;
@@ -1891,9 +1996,9 @@ private Links() {
private String subscription;
/**
- * (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was created
- * from this subscription request.
- *
+ * (Optional) ID of the 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 77922702..48fb2d7c 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestFlow.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestFlow.java
@@ -86,8 +86,8 @@ public String getId() {
}
/**
- * Sets the default language of the Billing Request Flow and the customer. [ISO
- * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code.
+ * Sets the default language of the Billing Request Flow and the customer.
+ * ISO 639-1 code.
*/
public String getLanguage() {
return language;
@@ -104,7 +104,6 @@ public Links getLinks() {
*
* You can only lock bank account if these have already been completed as a part of the billing
* request.
- *
*/
public Boolean getLockBankAccount() {
return lockBankAccount;
@@ -126,7 +125,6 @@ public Boolean getLockCurrency() {
*
* You can only lock customer details if these have already been completed as a part of the
* billing request.
- *
*/
public Boolean getLockCustomerDetails() {
return lockCustomerDetails;
@@ -206,8 +204,9 @@ private Links() {
private String billingRequest;
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this flow
- * was created.
+ * ID of the billing
+ * request against which this flow was created.
*/
public String getBillingRequest() {
return billingRequest;
@@ -230,8 +229,9 @@ private PrefilledBankAccount() {
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
- * accounts in other currencies. See [local details](#local-bank-details-united-states) for
- * more information.
+ * accounts in other currencies. See local
+ * details for more information.
*/
public AccountType getAccountType() {
return accountType;
@@ -300,16 +300,17 @@ public String getCity() {
}
/**
- * Customer's company name. Company name should only be provided if `given_name` and
- * `family_name` are null.
+ * Customer's company name. Company name should only be provided if given_name
+ * and family_name are null.
*/
public String getCompanyName() {
return companyName;
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public String getCountryCode() {
return countryCode;
diff --git a/src/main/java/com/gocardless/resources/BillingRequestTemplate.java b/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
index 0dd9d044..57718c86 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestTemplate.java
@@ -31,7 +31,7 @@ private BillingRequestTemplate() {
private String mandateRequestDescription;
private Mapredirect_uri.
*/
public String getAuthorisationUrl() {
return authorisationUrl;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -73,7 +75,7 @@ public MandateRequestConstraints getMandateRequestConstraints() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+ * ISO 4217 currency code.
*/
public String getMandateRequestCurrency() {
return mandateRequestCurrency;
@@ -82,7 +84,6 @@ public String getMandateRequestCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public String getMandateRequestDescription() {
return mandateRequestDescription;
@@ -108,29 +109,9 @@ public String getMandateRequestScheme() {
}
/**
- * Verification preference for the mandate. One of:
- * GBP and EUR supported; GBP with your customers in the
+ * UK and for EUR with your customers in supported Eurozone countries only.
*/
public String getPaymentRequestCurrency() {
return paymentRequestCurrency;
@@ -169,7 +150,6 @@ public String getPaymentRequestCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public String getPaymentRequestDescription() {
return paymentRequestDescription;
@@ -185,11 +165,12 @@ public Mapfaster_payments is
+ * supported in the UK (GBP) and sepa_credit_transfer and
+ * sepa_instant_credit_transfer are supported in supported Eurozone countries
+ * (EUR). For Eurozone countries, sepa_credit_transfer is used as the default.
+ * Please be aware that sepa_instant_credit_transfer may incur an additional fee
+ * for your customer.
*/
public String getPaymentRequestScheme() {
return paymentRequestScheme;
@@ -203,22 +184,14 @@ public String getRedirectUri() {
}
/**
- * Dynamic [timestamp](#api-usage-dates-and-times) recording when this resource was last
- * updated.
+ * Dynamic timestamp
+ * recording when this resource was last updated.
*/
public String getUpdatedAt() {
return updatedAt;
}
- public enum MandateRequestVerify {
- @SerializedName("minimum")
- MINIMUM, @SerializedName("recommended")
- RECOMMENDED, @SerializedName("when_available")
- WHEN_AVAILABLE, @SerializedName("always")
- ALWAYS, @SerializedName("unknown")
- UNKNOWN
- }
-
/**
* Represents a mandate request constraint resource returned from the API.
*
@@ -242,14 +215,15 @@ private MandateRequestConstraints() {
* This is an optional field and if it is not supplied the agreement will be considered open
* and will not have an end date. Keep in mind the end date must take into account how long
* it will take the user to set up this agreement via the Billing Request.
- *
*/
public String getEndDate() {
return endDate;
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and VRP.
+ * The maximum amount that can be charged for a single payment in the lowest denomination
+ * for the currency (e.g. pence in GBP, cents in EUR). Note: Required for PayTo and
+ * VRP.
*/
public Integer getMaxAmountPerPayment() {
return maxAmountPerPayment;
@@ -257,15 +231,20 @@ public Integer getMaxAmountPerPayment() {
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public String getPaymentMethod() {
return paymentMethod;
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public Listcreation_date if not specified.
*
- * `calendar` - this will finish on the end of the current period. For example this will
- * expire on the Monday for the current week or the January for the next year.
+ * calendar
+ * week runs Monday to Sunday, month runs from the 1st to the
+ * last day of the calendar month, and year runs from 1 January to 31
+ * December. If the mandate starts partway through a period, the limit for that first
+ * period is reduced proportionally to the days remaining (e.g. a monthly limit starting
+ * on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period. For
- * example Monthly it will expire on the same day of the next month, or yearly the same
- * day of the next year.
+ * creation_date
+ * flexible.
*/
public Alignment getAlignment() {
return alignment;
}
/**
- * The maximum number of payments that can be collected in this periodic limit. _Note:_
- * This is only supported for the PayTo scheme, where it is required.
+ * The maximum number of payments that can be collected in this periodic limit.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public Integer getMaxPayments() {
return maxPayments;
}
/**
- * The maximum total amount that can be charged for all payments in this periodic limit.
- * Required for VRP.
+ * The maximum total amount that can be charged for all payments in this periodic limit,
+ * in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public Integer getMaxTotalAmount() {
return maxTotalAmount;
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is provided
+ * (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this
+ * defaults to flexible.
*/
public Period getPeriod() {
return period;
diff --git a/src/main/java/com/gocardless/resources/BillingRequestWithAction.java b/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
index c7068523..4aedb60e 100644
--- a/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
+++ b/src/main/java/com/gocardless/resources/BillingRequestWithAction.java
@@ -11,9 +11,8 @@
* 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 Requests:
- * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) for
- * how-to's, explanations and tutorials.
+ * See Billing
+ * Requests: Overview for how-to's, explanations and tutorials.
*/
public class BillingRequestWithAction {
private BillingRequestWithAction() {
@@ -39,12 +38,12 @@ 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 Requests:
- * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) for
- * how-to's, explanations and tutorials.
+ * See
+ * Billing
+ * Requests: Overview for how-to's, explanations and tutorials.
*
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with subscription_request
+ * and instalment_schedule_request are only supported for ACH and PAD schemes.
*
url to the payer to allow them to authorise
+ * with their mobile devices.
*/
public String getQrCodeUrl() {
return qrCodeUrl;
@@ -137,24 +138,27 @@ public String getQrCodeUrl() {
/**
* URL that the payer can be redirected to after authorising the payment.
*
- * On completion of bank authorisation, the query parameter of either `outcome=success` or
- * `outcome=failure` will be appended to the `redirect_uri` to indicate the result of the
- * bank authorisation. If the bank authorisation is expired, the query parameter
- * `outcome=timeout` will be appended to the `redirect_uri`, in which case you should prompt
- * the user to try the bank authorisation step again.
+ * On completion of bank authorisation, the query parameter of either
+ * outcome=success or outcome=failure will be appended to the
+ * redirect_uri to indicate the result of the bank authorisation. If the bank
+ * authorisation is expired, the query parameter outcome=timeout will be
+ * appended to the redirect_uri, in which case you should prompt the user to
+ * try the bank authorisation step again.
*
- * 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`](#billing-request-bankauthorisationauthorised),
- * [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or
- * [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in order to show
- * the correct outcome to the user.
+ * 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,
+ * BANK_AUTHORISATION_DENIED,
+ * or 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 parameter
- * `id=BRF123`.
+ * The BillingRequestFlow ID will also be appended to the redirect_uri as query
+ * parameter id=BRF123.
*
- * Defaults to `https://pay.gocardless.com/billing/static/thankyou`.
+ * Defaults to https://pay.gocardless.com/billing/static/thankyou.
*/
public String getRedirectUri() {
return redirectUri;
@@ -188,16 +192,18 @@ private Links() {
private String institution;
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this
- * authorisation was created.
+ * ID of the billing
+ * request against which this authorisation was created.
*/
public String getBillingRequest() {
return billingRequest;
}
/**
- * ID of the [institution](#billing-requests-institutions) against which this
- * authorisation was created.
+ * ID of the institution
+ * against which this authorisation was created.
*/
public String getInstitution() {
return institution;
@@ -212,12 +218,12 @@ 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 Requests:
- * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) for
- * how-to's, explanations and tutorials.
+ * See
+ * Billing
+ * Requests: Overview for how-to's, explanations and tutorials.
*
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with subscription_request
+ * and instalment_schedule_request are only supported for ACH and PAD schemes.
*
instalments_with_schedule object or an array of
+ * instalments_with_dates objects
*/
public InstalmentScheduleRequest getInstalmentScheduleRequest() {
return instalmentScheduleRequest;
@@ -322,9 +331,9 @@ public PaymentContextCode getPaymentContextCode() {
/**
* 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 Commercial Payment Purpose
- * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for the
- * complete list of valid codes.
+ * compliance. See
+ * VRP
+ * Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public String getPaymentPurposeCode() {
return paymentPurposeCode;
@@ -340,9 +349,9 @@ public PaymentRequest getPaymentRequest() {
/**
* 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](https://developer.gocardless.com/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 PurposeCode getPurposeCode() {
return purposeCode;
@@ -354,12 +363,15 @@ public Resources getResources() {
/**
* One of:
+ *
* pending: the billing request is pending and can be usedready_to_fulfil: the billing request is ready to fulfilfulfilling: the billing request is currently undergoing fulfilmentfulfilled: the billing request has been fulfilled and a payment
+ * createdcancelled: the billing request has been cancelled and cannot be
+ * usednot_needed: we won't attempt to infer the institution as it is not
+ * needed. Either because it was manually selected or the billing request does not
+ * support this featurepending: we are waiting on the bank details in order to infer the
+ * institutionfailed: we weren't able to infer the institutionsuccess: we inferred the institution and added it to the resources
+ * of a Billing Requestinstalments_with_schedule object or an array of
+ * instalments_with_dates objects
*/
public static class InstalmentScheduleRequest {
private InstalmentScheduleRequest() {
@@ -697,16 +715,18 @@ public Integer getAppFee() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "USD" and "CAD" are supported.
+ * ISO 4217 currency
+ * code. Currently "USD" and "CAD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * An explicit array of instalment payments, each specifying at least an `amount` and
- * `charge_date`. See [create (with dates)](#instalment-schedules-create-with-dates)
+ * An explicit array of instalment payments, each specifying at least an
+ * amount and charge_date. See create
+ * (with dates)
*/
public Listfalse.
* * Important: To be able to use intelligent retries, Success+ needs to - * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). + * be enabled in GoCardless + * dashboard. *
*/ public Boolean getRetryIfPossible() { @@ -790,6 +816,14 @@ private InstalmentsWithDate() { /** * Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in * EUR). + * + * Minimum and maximum amounts vary by payment scheme. For more information, see + * Transaction + * limits + * + * For Variable Recurring Payments (VRP), this must not exceed the mandate's + *max_amount_per_payment constraint.
*/
public Integer getAmount() {
return amount;
@@ -797,8 +831,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](#core-endpoints-mandates), 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;
@@ -807,8 +842,9 @@ 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
- * requirements](#appendix-compliance-requirements)).
+ * not send its own notifications (see compliance
+ * requirements).
*/
public String getDescription() {
return description;
@@ -820,8 +856,9 @@ 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 (with schedule)](#instalment-schedules-create-with-schedule)
- *
+ * create
+ * (with schedule)
*/
public static class InstalmentsWithSchedule {
private InstalmentsWithSchedule() {
@@ -836,24 +873,22 @@ private InstalmentsWithSchedule() {
/**
* List of amounts of each instalment, in the lowest denomination for the currency
* (e.g. cents in USD).
- *
*/
public Listinterval_units between charge dates. Must be greater than
+ * or equal to 1.
*/
public Integer getInterval() {
return interval;
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public IntervalUnit getIntervalUnit() {
return intervalUnit;
@@ -861,10 +896,12 @@ public IntervalUnit getIntervalUnit() {
/**
* The date on which the first payment should be charged. Must be on or after the
- * [mandate](#core-endpoints-mandates)'s `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 mandate's `next_possible_charge_date`
+ * mandate's
+ * 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 mandate's next_possible_charge_date
*/
public String getStartDate() {
return startDate;
@@ -892,9 +929,9 @@ private Links() {
private String instalmentSchedule;
/**
- * (Optional) ID of the [instalment_schedule](#core-endpoints-instalment-schedules)
+ * (Optional) ID of the instalment_schedule
* that was created from this instalment schedule request.
- *
*/
public String getInstalmentSchedule() {
return instalmentSchedule;
@@ -929,29 +966,34 @@ private Links() {
private String subscriptionRequestSubscription;
/**
- * (Optional) ID of the [bank authorisation](#billing-requests-bank-authorisations) that
- * was used to verify this request.
+ * (Optional) ID of the bank
+ * authorisation that was used to verify this request.
*/
public String getBankAuthorisation() {
return bankAuthorisation;
}
/**
- * ID of the associated [creditor](#core-endpoints-creditors).
+ * ID of the associated creditor.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of the [customer](#core-endpoints-customers) that will be used for this request
+ * ID of the customer
+ * that will be used for this request
*/
public String getCustomer() {
return customer;
}
/**
- * (Optional) ID of the [customer_bank_account](#core-endpoints-customer-bank-accounts)
+ * (Optional) ID of the customer_bank_account
* that will be used for this request
*/
public String getCustomerBankAccount() {
@@ -973,8 +1015,9 @@ public String getInstalmentScheduleRequest() {
}
/**
- * (Optional) ID of the [instalment_schedule](#core-endpoints-instalment-schedules) that
- * was created from this instalment schedule request.
+ * (Optional) ID of the instalment_schedule
+ * that was created from this instalment schedule request.
*/
public String getInstalmentScheduleRequestInstalmentSchedule() {
return instalmentScheduleRequestInstalmentSchedule;
@@ -988,8 +1031,9 @@ public String getMandateRequest() {
}
/**
- * (Optional) ID of the [mandate](#core-endpoints-mandates) 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;
@@ -1017,8 +1061,9 @@ public String getPaymentRequest() {
}
/**
- * (Optional) ID of the [payment](#core-endpoints-payments) that was created from this
- * payment request.
+ * (Optional) ID of the payment
+ * that was created from this payment request.
*/
public String getPaymentRequestPayment() {
return paymentRequestPayment;
@@ -1032,8 +1077,9 @@ public String getSubscriptionRequest() {
}
/**
- * (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was created
- * from this subscription request.
+ * (Optional) ID of the subscription
+ * that was created from this subscription request.
*/
public String getSubscriptionRequestSubscription() {
return subscriptionRequestSubscription;
@@ -1064,15 +1110,14 @@ private MandateRequest() {
private Verify verify;
/**
- * This field is ACH specific, sometimes referred to as [SEC
- * code](https://www.moderntreasury.com/learn/sec-codes).
+ * This field is ACH specific, sometimes referred to as
+ * SEC code.
*
* This is the way that the payer gives authorisation to the merchant. web:
* Authorisation is Internet Initiated or via Mobile Entry (maps to SEC code: WEB)
* telephone: Authorisation is provided orally over telephone (maps to SEC code: TEL)
* paper: Authorisation is provided in writing and signed, or similarly authenticated
* (maps to SEC code: PPD)
- *
*/
public AuthorisationSource getAuthorisationSource() {
return authorisationSource;
@@ -1080,10 +1125,10 @@ public AuthorisationSource getAuthorisationSource() {
/**
* This attribute represents the authorisation type between the payer and merchant. It
- * can be set to `one_off`, `recurring` or `standing` for ACH scheme. And `single`,
- * `recurring` and `sporadic` for PAD scheme. _Note:_ This is only supported for ACH and
- * PAD schemes.
- *
+ * can be set to one_off, recurring or standing
+ * for ACH scheme. And single, recurring and
+ * sporadic for PAD scheme. Note: This is only supported for ACH
+ * and PAD schemes.
*/
public String getConsentType() {
return consentType;
@@ -1098,7 +1143,8 @@ public Constraints getConstraints() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+ * ISO 4217 currency
+ * code.
*/
public String getCurrency() {
return currency;
@@ -1107,7 +1153,6 @@ public String getCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to
* the payer when authorising the billing request.
- *
*/
public String getDescription() {
return description;
@@ -1116,10 +1161,12 @@ public String getDescription() {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. -
- * `direct` will be a direct transfer from the payer's account to the merchant where
- * invoicing will be handled separately.
- *
+ * managed will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.minimum: only verify if absolutely required, such as when part of
+ * scheme rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use
+ * themalways: as when_available, but fail to create the
+ * Billing Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer
+ * is fraudulent or not. The verification mechanism is based on the response and the
+ * payer may be asked to verify themselves. If the feature is not available,
+ * recommended behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified
- * Mandates as they are released in new schemes, please use the `minimum` verification
- * preference.
+ * Mandates as they are released in new schemes, please use the minimum
+ * verification preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public Verify getVerify() {
return verify;
@@ -1246,15 +1294,15 @@ private Constraints() {
* considered open and will not have an end date. Keep in mind the end date must
* take into account how long it will take the user to set up this agreement via the
* Billing Request.
- *
*/
public String getEndDate() {
return endDate;
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo
- * and VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public Integer getMaxAmountPerPayment() {
return maxAmountPerPayment;
@@ -1262,15 +1310,20 @@ public Integer getMaxAmountPerPayment() {
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount
+ * and frequency. Note: This is only supported for ACH and PAD schemes.
*/
public String getPaymentMethod() {
return paymentMethod;
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be
+ * provided. Optional for PayTo.
*/
public Listcreation_date if not
+ * specified.
*
- * `calendar` - this will finish on the end of the current period. For example
- * this will expire on the Monday for the current week or the January for the
- * next year.
+ * calendar
+ * week runs Monday to Sunday, month runs from the 1st
+ * to the last day of the calendar month, and year runs from 1
+ * January to 31 December. If the mandate starts partway through a period, the
+ * limit for that first period is reduced proportionally to the days remaining
+ * (e.g. a monthly limit starting on the 15th gives roughly half the limit for
+ * that first month).
*
- * `creation_date` - this will finish on the next instance of the current
- * period. For example Monthly it will expire on the same day of the next month,
- * or yearly the same day of the next year.
+ * creation_date
+ * flexible.
*/
public Alignment getAlignment() {
return alignment;
@@ -1320,8 +1386,8 @@ public Alignment getAlignment() {
/**
* The maximum number of payments that can be collected in this periodic limit.
- * _Note:_ This is only supported for the PayTo scheme, where it is required.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public Integer getMaxPayments() {
return maxPayments;
@@ -1329,16 +1395,19 @@ public Integer getMaxPayments() {
/**
* The maximum total amount that can be charged for all payments in this
- * periodic limit. Required for VRP.
+ * periodic limit, in the lowest denomination for the currency (e.g. pence in
+ * GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public Integer getMaxTotalAmount() {
return maxTotalAmount;
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is
+ * provided (for both VRP and PayTo). If periodic_limits is omitted entirely for
+ * PayTo, this defaults to flexible.
*/
public Period getPeriod() {
return period;
@@ -1376,9 +1445,9 @@ private Links() {
private String mandate;
/**
- * (Optional) ID of the [mandate](#core-endpoints-mandates) 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;
@@ -1423,9 +1492,10 @@ public Integer getAppFee() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP`
- * and `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your
- * customers in supported Eurozone countries only.
+ * ISO 4217 currency
+ * code. GBP and EUR supported; GBP with your
+ * customers in the UK and for EUR with your customers in supported
+ * Eurozone countries only.
*/
public String getCurrency() {
return currency;
@@ -1434,7 +1504,6 @@ public String getCurrency() {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to
* the payer when authorising the billing request.
- *
*/
public String getDescription() {
return description;
@@ -1443,10 +1512,12 @@ public String getDescription() {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. -
- * `direct` will be a direct transfer from the payer's account to the merchant where
- * invoicing will be handled separately.
- *
+ * managed will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your
* customer.
*/
public String getScheme() {
@@ -1506,8 +1577,9 @@ private Links() {
private String payment;
/**
- * (Optional) ID of the [payment](#core-endpoints-payments) that was created from
- * this payment request.
+ * (Optional) ID of the payment
+ * that was created from this payment request.
*/
public String getPayment() {
return payment;
@@ -1571,18 +1643,20 @@ private Customer() {
private String phoneNumber;
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are
- * provided. For Canadian customers, the use of a `company_name` value will mean
- * that any mandate created from this customer will be considered to be a "Business
- * PAD" (otherwise, any mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this
+ * customer will be considered to be a "Business PAD" (otherwise, any mandate will
+ * be considered to be a "Personal PAD").
*/
public String getCompanyName() {
return companyName;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was
- * created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -1597,14 +1671,14 @@ public String getEmail() {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public String getFamilyName() {
return familyName;
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public String getGivenName() {
return givenName;
@@ -1618,13 +1692,13 @@ public String getId() {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as
- * the language for notification emails sent by GoCardless if your organisation does
- * not send its own (see [compliance
- * requirements](#appendix-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".
+ * ISO 639-1
+ * code. Used as the language for notification emails sent by GoCardless if your
+ * organisation does not send 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".
*/
public String getLanguage() {
return language;
@@ -1639,8 +1713,8 @@ public Mapiban if
+ * supplied, otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was
- * created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
- * supported.
+ * ISO 4217
+ * currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and
+ * "USD" are supported.
*/
public String getCurrency() {
return currency;
@@ -1765,6 +1844,25 @@ public Mapfull: The name provided matches the name held by the bank.close: The name provided is a close but not exact match to the
+ * name held by the bank.cannot_perform_verification: A verification was attempted but
+ * could not be completed. This can happen for a number of reasons, including the
+ * account holder's bank not participating in the verification scheme, the account
+ * not being eligible for verification (e.g. the account holder has opted out), or
+ * the bank details not being resolvable, among others.authorisation_source is set to telephone or paper.
*/
public String getIpAddress() {
return ipAddress;
@@ -1899,8 +2008,8 @@ public String getPostalCode() {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is
- * required (e.g. `CA` for California).
+ * ISO3166-2:US state code
+ * is required (e.g. CA for California).
*/
public String getRegion() {
return region;
@@ -1974,32 +2083,36 @@ public Integer getCount() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "USD" and "CAD" are supported.
+ * ISO 4217 currency
+ * code. Currently "USD" and "CAD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or `-1` to
- * indicate the last day of the month.
+ * As per RFC 2445. The day of the month to charge customers on. 1
+ * 28 or -1 to indicate the last day of the month.
*/
public Integer getDayOfMonth() {
return dayOfMonth;
}
/**
- * Number of `interval_units` between customer charge dates. Must be greater than or
- * equal to `1`. Must result in at least one charge date per year. Defaults to `1`.
+ * Number of interval_units between customer charge dates. Must be greater
+ * than or equal to 1. Must result in at least one charge date per year.
+ * Defaults to 1.
*/
public Integer getInterval() {
return interval;
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public IntervalUnit getIntervalUnit() {
return intervalUnit;
@@ -2019,8 +2132,7 @@ public Mapyearly.
*/
public Month getMonth() {
return month;
@@ -2037,18 +2149,23 @@ 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 payment endpoint](#payments-create-a-payment) for more details. false.
* * Important: To be able to use intelligent retries, Success+ needs to - * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). + * be enabled in GoCardless + * dashboard. *
*/ public Boolean getRetryIfPossible() { @@ -2057,11 +2174,11 @@ public Boolean getRetryIfPossible() { /** * The date on which the first payment should be charged. If fulfilled after this date, - * this will be set as the mandate's `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 - * mandate's `next_possible_charge_date`. - * + * this will be set as the mandate'snext_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 mandate's
+ * next_possible_charge_date.
*/
public String getStartDate() {
return startDate;
@@ -2105,9 +2222,9 @@ private Links() {
private String subscription;
/**
- * (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was
- * created from this subscription request.
- *
+ * (Optional) ID of the subscription
+ * that was created from this subscription request.
*/
public String getSubscription() {
return subscription;
diff --git a/src/main/java/com/gocardless/resources/Block.java b/src/main/java/com/gocardless/resources/Block.java
index e0fa955a..840ab626 100644
--- a/src/main/java/com/gocardless/resources/Block.java
+++ b/src/main/java/com/gocardless/resources/Block.java
@@ -18,9 +18,10 @@
*
* Please note:
*
- * - Payments and subscriptions cannot be created against a mandate in blocked state. - A mandate
- * can never be transitioned out of the blocked state.
- *
+ * bank_reference_prefix was ACME, the bank reference of a
+ * payout sent to that creditor could be ACME-8G7Q8.
*
* This prefix is also used for refunds in EUR and GBP.
- *
*/
public String getBankReferencePrefix() {
return bankReferencePrefix;
@@ -88,41 +89,46 @@ public String getCity() {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * The type of business of the creditor. Currently, `individual`, `company`, `charity`,
- * `partnership`, and `trust` are supported.
+ * The type of business of the creditor. Currently, individual,
+ * company, charity, partnership, and trust
+ * are supported.
*/
public CreditorType getCreditorType() {
return creditorType;
}
/**
- * Boolean value indicating whether creditor has the [Custom Payment
- * Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) functionality enabled.
+ * Boolean value indicating whether creditor has the
+ * Custom Payment Pages
+ * functionality enabled.
*/
public Boolean getCustomPaymentPagesEnabled() {
return customPaymentPagesEnabled;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK",
- * "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or were)
- * made via foreign exchange.
+ * ISO 4217 code for the
+ * currency in which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD",
+ * "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be
+ * (or were) made via foreign exchange.
*/
public FxPayoutCurrency getFxPayoutCurrency() {
return fxPayoutCurrency;
@@ -147,8 +153,9 @@ public String getLogoUrl() {
}
/**
- * Boolean value indicating whether creditor has the [Mandate
- * Imports](#core-endpoints-mandate-imports) functionality enabled.
+ * Boolean value indicating whether creditor has the Mandate
+ * Imports functionality enabled.
*/
public Boolean getMandateImportsEnabled() {
return mandateImportsEnabled;
@@ -156,9 +163,10 @@ 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](/getting-started/api/handling-customer-notifications/)). If you are a partner app, and
- * this value is true, you should not send notifications on behalf of this organisation.
+ * 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.
*/
public Boolean getMerchantResponsibleForNotifications() {
return merchantResponsibleForNotifications;
@@ -188,9 +196,11 @@ public String getRegion() {
/**
* An array of the scheme identifiers this creditor can create mandates against.
*
- * The support address, `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 requirements](#appendix-compliance-requirements) for more details.
+ * The support address, 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
+ * requirements for more details.
*/
public Listsuccessful: The creditor's account is fully verified, and they can receive
+ * payouts. Once a creditor has been successfully verified, they may in the future require
+ * further verification - for example, if they change their payout bank account, we will have to
+ * check that they own the new bank account before they can receive payouts again.in_review: The creditor has provided all of the information currently
+ * requested, and it is awaiting review by GoCardless before they can be verified and receive
+ * payouts.action_required: The creditor needs to provide further information to verify
+ * their account so they can receive payouts, and should visit the verification flow.active scheme identifiers will be
+ * applied to a creditor and used against payments.
*/
public Status getStatus() {
return status;
diff --git a/src/main/java/com/gocardless/resources/CreditorBankAccount.java b/src/main/java/com/gocardless/resources/CreditorBankAccount.java
index ff78a649..ad2e4091 100644
--- a/src/main/java/com/gocardless/resources/CreditorBankAccount.java
+++ b/src/main/java/com/gocardless/resources/CreditorBankAccount.java
@@ -6,13 +6,16 @@
/**
* Represents a creditor bank account resource returned from the API.
*
- * Creditor Bank Accounts hold the bank details of a [creditor](#core-endpoints-creditors). These
- * are the bank accounts which your [payouts](#core-endpoints-payouts) will be sent to.
+ * Creditor Bank Accounts hold the bank details of a
+ * creditor.
+ * These are the bank accounts which your
+ * payouts will
+ * be sent to.
*
* Note that creditor bank accounts must be unique, and so you will encounter a
- * `bank_account_exists` error if you try to create a duplicate bank account. You may wish to handle
- * this by updating the existing record instead, the ID of which will be provided as
- * `links[creditor_bank_account]` in the error response.
+ * bank_account_exists error if you try to create a duplicate bank account. You may
+ * wish to handle this by updating the existing record instead, the ID of which will be provided as
+ * links[creditor_bank_account] in the error response.
*
*
* Restricted: This API is not available for partner integrations.
@@ -38,8 +41,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](#core-endpoints-creditors). 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;
@@ -55,8 +59,9 @@ public String getAccountNumberEnding() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank
- * accounts in other currencies. See [local details](#local-bank-details-united-states) for more
- * information.
+ * accounts in other currencies. See local
+ * details for more information.
*/
public AccountType getAccountType() {
return accountType;
@@ -70,24 +75,27 @@ public String getBankName() {
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the
+ * Important: Events older than 18 months will be archived and no longer accessible
+ * via the API or exports. Archival will begin no sooner than 1 August 2026 in sandbox environments,
+ * and no sooner than 1 October 2026 in live environments. Events within the 18-month window are
+ * unaffected. If you need archived data, contact GoCardless support.
+ *
* Note that all Mandate Imports have an upper limit of 30,000 entries, so we recommend you split
* your import into several smaller imports if you're planning to exceed this threshold.
*
* Restricted: This API is currently only available for approved integrators -
* please get in touch if you would like to use this API.
@@ -48,7 +61,9 @@ private MandateImport() {
private Status status;
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -70,6 +85,7 @@ public Links getLinks() {
/**
* The scheme of the mandates to be imported.
* Restricted: This API is currently only available for approved integrators -
@@ -39,7 +42,9 @@ private MandateImportEntry() {
private String recordIdentifier;
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -62,7 +67,6 @@ public Map
- * Note that the `create` and `update` endpoints behave differently than other existing `create` and
- * `update` endpoints. The Payer Authorisation is still saved if incomplete data is provided. We
- * return the list of incomplete data in the `incomplete_fields` along with the resources in the
- * body of the response. The bank account details(account_number, bank_code & branch_code) must be
- * sent together rather than splitting across different request for both `create` and `update`
+ * Note that the
+ *
* Restricted: You can only specify a payment reference for Bacs payments (that
* is, when collecting from the UK) if you're on the
- * GoCardless Plus, Pro or Enterprise packages.
+ * GoCardless Plus, Pro or Enterprise packages.
*
+ *
* Restricted: You can not specify a payment reference for Faster Payments.
*
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* For accuracy, we store some of our fees to greater precision than we can actually pay out
* (for example, a GoCardless fee we record might come to 0.5 pence, but it is not possible to
* send a payout via bank transfer including a half penny).
* Deprecated: Redirect Flows are legacy APIs and cannot be used by new
- * integrators. The [Billing Request flow](#billing-requests) API should be used for your payment
- * flows.
+ * integrators. The Billing
+ * Request flow API should be used for your payment flows.
*
+ *
* Restricted: You can only specify a payment reference for Bacs payments (that
* is, when collecting from the UK) if you're on the
- * GoCardless Plus, Pro or Enterprise packages.
+ * GoCardless Plus, Pro or Enterprise packages.
*
+ *
* Restricted: You can not specify a payment reference for Faster Payments.
*
- * Deprecated: This field will be removed in a future API version. Use `count`
- * to specify a number of payments instead.
+ * Deprecated: This field will be removed in a future API version. Use
+ *
* Restricted: You need your own Service User Number to specify a payment
* reference for Bacs payments.
@@ -208,11 +229,12 @@ public String getPaymentReference() {
}
/**
- * On failure, automatically retry payments using [intelligent retries](/success-plus/overview).
- * Default is `false`.
+ * 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](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Restricted: These endpoints are restricted to customers who want to collect
- * their merchant's verification details and pass them to GoCardless via our API. Please [get in
- * touch](mailto:help@gocardless.com) if you wish to enable this feature on your account.
+ * their merchant's verification details and pass them to GoCardless via our API. Please
+ * get in touch if you wish to enable this feature on your
+ * account.
*
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with
- * Important: All properties associated with `subscription_request` and
- * `instalment_schedule_request` are only supported for ACH and PAD schemes.
+ * Important: All properties associated with
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Important: This is not applicable to Pay by Bank and VRP payments.
@@ -708,11 +721,12 @@ public BillingRequestCreateRequest withPaymentRequestRetryIfPossible(
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer`
- * are supported in supported Eurozone countries (EUR). For Eurozone countries,
- * `sepa_credit_transfer` is used as the default. Please be aware that
- * `sepa_instant_credit_transfer` may incur an additional fee for your customer.
+ * (Optional) A scheme used for Open Banking payments. Currently
+ *
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Important: To be able to use intelligent retries, Success+ needs to
- * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * be enabled in GoCardless
+ * dashboard.
*
* Important: To be able to use intelligent retries, Success+ needs to
- * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * be enabled in GoCardless
+ * dashboard.
*
* Important: This is not applicable to Pay by Bank and VRP payments.
@@ -1768,11 +1833,12 @@ public PaymentRequest withRetryIfPossible(Boolean retryIfPossible) {
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and
- * `sepa_instant_credit_transfer` are supported in supported Eurozone countries (EUR).
- * For Eurozone countries, `sepa_credit_transfer` is used as the default. Please be
- * aware that `sepa_instant_credit_transfer` may incur an additional fee for your
+ * (Optional) A scheme used for Open Banking payments. Currently
+ *
* Important: To be able to use intelligent retries, Success+ needs to
- * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * be enabled in GoCardless
+ * dashboard.
*
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Important: This is not applicable to Pay by Bank and VRP payments.
@@ -527,11 +533,12 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestRetryI
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer`
- * are supported in supported Eurozone countries (EUR). For Eurozone countries,
- * `sepa_credit_transfer` is used as the default. Please be aware that
- * `sepa_instant_credit_transfer` may incur an additional fee for your customer.
+ * (Optional) A scheme used for Open Banking payments. Currently
+ *
* Important: To be able to use intelligent retries, Success+ needs to
- * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * be enabled in GoCardless
+ * dashboard.
*
* Important: This is not applicable to Pay by Bank and VRP payments.
@@ -1720,11 +1765,12 @@ public PaymentRequest withRetryIfPossible(Boolean retryIfPossible) {
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and
- * `sepa_instant_credit_transfer` are supported in supported Eurozone countries (EUR).
- * For Eurozone countries, `sepa_credit_transfer` is used as the default. Please be
- * aware that `sepa_instant_credit_transfer` may incur an additional fee for your
+ * (Optional) A scheme used for Open Banking payments. Currently
+ *
* Restricted: This API is not available for partner integrations.
@@ -44,8 +47,9 @@ public CreditorBankAccountCreateRequest create() {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank
- * accounts.
+ * Returns a cursor-paginated
+ * list of your creditor bank accounts.
*/
public CreditorBankAccountListRequest
+ * Important: Events older than 18 months will be archived and no longer accessible
+ * via the API or exports. Archival will begin no sooner than 1 August 2026 in sandbox environments,
+ * and no sooner than 1 October 2026 in live environments. Events within the 18-month window are
+ * unaffected. If you need archived data, contact GoCardless support.
+ *
+ * Important: This endpoint will no longer return events older than 18 months,
+ * including when filtering by resource. This takes effect no sooner than 1 August 2026 in
+ * sandbox environments, and no sooner than 1 October 2026 in live environments.
+ *
+ * Important: This endpoint will no longer return events older than 18 months,
+ * including when filtering by resource. This takes effect no sooner than 1 August 2026 in
+ * sandbox environments, and no sooner than 1 October 2026 in live environments.
+ *
+ *
* Restricted: You can only specify a payment reference for Bacs payments
* (that is, when collecting from the UK) if you're on the
- * GoCardless Plus, Pro or Enterprise packages.
+ * GoCardless Plus, Pro or Enterprise packages.
*
+ *
* Restricted: You can not specify a payment reference for Faster Payments.
*
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
+ *
* Restricted: You can only specify a payment reference for Bacs payments
* (that is, when collecting from the UK) if you're on the
- * GoCardless Plus, Pro or Enterprise packages.
+ * GoCardless Plus, Pro or Enterprise packages.
*
+ *
* Restricted: You can not specify a payment reference for Faster Payments.
*
* Important: To be able to use intelligent retries, Success+ needs to be
- * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
+ * enabled in GoCardless dashboard.
*
* Restricted: This API is currently only available for approved integrators -
@@ -47,11 +50,13 @@ public MandateImportEntryService(HttpClient httpClient) {
}
/**
- * For an existing [mandate import](#core-endpoints-mandate-imports), 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.
+ * this limit, the API will return a
* Note that all Mandate Imports have an upper limit of 30,000 entries, so we recommend you split
* your import into several smaller imports if you're planning to exceed this threshold.
*
* Restricted: This API is currently only available for approved integrators -
* please get in touch if you would like to use this API.
@@ -54,7 +67,9 @@ 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](#mandate-imports-submit-a-mandate-import) it.
+ * import, you should submit
+ * it.
*/
public MandateImportCreateRequest create() {
return new MandateImportCreateRequest(httpClient);
@@ -93,7 +108,9 @@ 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](#mandate-imports-submit-a-mandate-import) it.
+ * import, you should submit
+ * it.
*/
public static final class MandateImportCreateRequest
extends IdempotentPostRequestiban if supplied,
+ * otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public String getCurrency() {
return currency;
@@ -120,7 +128,8 @@ public Mappending,
+ * in_review or successful
*/
public VerificationStatus getVerificationStatus() {
return verificationStatus;
@@ -155,7 +164,9 @@ private Links() {
private String creditor;
/**
- * ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
+ * ID of the creditor
+ * that owns this bank account.
*/
public String getCreditor() {
return creditor;
diff --git a/src/main/java/com/gocardless/resources/Customer.java b/src/main/java/com/gocardless/resources/Customer.java
index cc6d0098..9a10b5d5 100644
--- a/src/main/java/com/gocardless/resources/Customer.java
+++ b/src/main/java/com/gocardless/resources/Customer.java
@@ -5,9 +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](#core-endpoints-customer-bank-accounts), which in turn can have several Direct
- * Debit [mandates](#core-endpoints-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() {
@@ -62,25 +63,29 @@ public String getCity() {
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are provided. For
- * Canadian customers, the use of a `company_name` value will mean that any mandate created from
- * this customer will be considered to be a "Business PAD" (otherwise, any mandate will be
- * considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer will be
+ * considered to be a "Business PAD" (otherwise, any mandate will be considered to be a
+ * "Personal PAD").
*/
public String getCompanyName() {
return companyName;
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -103,14 +108,14 @@ public String getEmail() {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public String getFamilyName() {
return familyName;
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public String getGivenName() {
return givenName;
@@ -124,11 +129,13 @@ public String getId() {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the language
- * for notification emails sent by GoCardless if your organisation does not send its own (see
- * [compliance requirements](#appendix-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".
+ * ISO 639-1 code. Used as
+ * the language for notification emails sent by GoCardless if your organisation does not send
+ * 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".
*/
public String getLanguage() {
return language;
@@ -143,8 +150,8 @@ public MapCA for California).
*/
public String getRegion() {
return region;
diff --git a/src/main/java/com/gocardless/resources/CustomerBankAccount.java b/src/main/java/com/gocardless/resources/CustomerBankAccount.java
index f9ae38e3..a5b40c7b 100644
--- a/src/main/java/com/gocardless/resources/CustomerBankAccount.java
+++ b/src/main/java/com/gocardless/resources/CustomerBankAccount.java
@@ -6,18 +6,21 @@
/**
* Represents a customer bank account resource returned from the API.
*
- * Customer Bank Accounts hold the bank details of a [customer](#core-endpoints-customers). They
- * always belong to a [customer](#core-endpoints-customers), and may be linked to several Direct
- * Debit [mandates](#core-endpoints-mandates).
+ * 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.
*
* 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 wish to handle
- * this by updating the existing record instead, the ID of which will be provided as
- * `links[customer_bank_account]` in the error response.
+ * bank_account_exists error if you try to create a duplicate bank account. You may
+ * wish to handle this by updating the existing record instead, the ID of which will be provided as
+ * links[customer_bank_account] in the error response.
*
- * _Note:_ To ensure the customer's bank accounts are valid, verify them first using
- * [bank_details_lookups](#bank-details-lookups-perform-a-bank-details-lookup), before proceeding
- * with creating the accounts
+ * Note: To ensure the customer's bank accounts are valid, verify them first using bank_details_lookups,
+ * before proceeding with creating the accounts
*/
public class CustomerBankAccount {
private CustomerBankAccount() {
@@ -36,13 +39,16 @@ private CustomerBankAccount() {
private String id;
private Links links;
private Mapiban if supplied,
+ * otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public String getCurrency() {
return currency;
@@ -130,6 +140,25 @@ public Map
+ *
+ */
+ public PayerNameVerificationResult getPayerNameVerificationResult() {
+ return payerNameVerificationResult;
+ }
+
/**
* Whether this customer bank account is registered as a trusted recipient for Outbound
* Payments. Only present when the feature is enabled for the organisation.
@@ -145,6 +174,14 @@ public enum AccountType {
UNKNOWN
}
+ public enum PayerNameVerificationResult {
+ @SerializedName("full")
+ FULL, @SerializedName("close")
+ CLOSE, @SerializedName("cannot_perform_verification")
+ CANNOT_PERFORM_VERIFICATION, @SerializedName("unknown")
+ UNKNOWN
+ }
+
/**
* Represents a link resource returned from the API.
*
@@ -158,7 +195,9 @@ private Links() {
private String customer;
/**
- * ID of the [customer](#core-endpoints-customers) that owns this bank account.
+ * ID of the customer
+ * that owns this bank account.
*/
public String getCustomer() {
return customer;
diff --git a/src/main/java/com/gocardless/resources/CustomerNotification.java b/src/main/java/com/gocardless/resources/CustomerNotification.java
index 749e5a0f..61d25a5b 100644
--- a/src/main/java/com/gocardless/resources/CustomerNotification.java
+++ b/src/main/java/com/gocardless/resources/CustomerNotification.java
@@ -7,7 +7,7 @@
*
* Customer Notifications represent the notification which is due to be sent to a customer after an
* event has happened. The event, the resource and the customer to be notified are all identified in
- * the `links` property.
+ * the full: The name provided matches the name held by the bank.close: The name provided is a close but not exact match to the name held by
+ * the bank.cannot_perform_verification: A verification was attempted but could not be
+ * completed. This can happen for a number of reasons, including the account holder's bank not
+ * participating in the verification scheme, the account not being eligible for verification
+ * (e.g. the account holder has opted out), or the bank details not being resolvable, among
+ * others.links property.
*
* Note that these are ephemeral records - once the notification has been actioned in some way, it
* is no longer visible using this API.
@@ -30,16 +30,17 @@ private CustomerNotification() {
private Type type;
/**
- * The action that was taken on the notification. Currently this can only be `handled`, which
- * means the integrator sent the notification themselves.
- *
+ * The action that was taken on the notification. Currently this can only be
+ * handled, which means the integrator sent the notification themselves.
*/
public ActionTaken getActionTaken() {
return actionTaken;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this action was taken.
+ * Fixed timestamp,
+ * recording when this action was taken.
*/
public String getActionTakenAt() {
return actionTakenAt;
@@ -65,15 +66,16 @@ public Links getLinks() {
/**
* The type of notification the customer shall receive. One of:
+ *
*
- *
*/
public Type getType() {
diff --git a/src/main/java/com/gocardless/resources/Event.java b/src/main/java/com/gocardless/resources/Event.java
index bba52e8f..ca57d9ef 100644
--- a/src/main/java/com/gocardless/resources/Event.java
+++ b/src/main/java/com/gocardless/resources/Event.java
@@ -10,8 +10,16 @@
* Events are stored for all webhooks. An event refers to a resource which has been updated, for
* 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](#event-types) for a complete
+ * corresponding event getting included in API responses. See
+ * here for a complete
* list of event types.
+ *
+ * payment_createdpayment_cancelledmandate_createdmandate_blockedsubscription_createdsubscription_cancelledinstalment_schedule_createdinstalment_schedule_cancelleddetails[origin] field is
+ * api otherwise it will be an empty object.
*/
public Mapmandate[metadata] field on the response you would receive from
+ * performing a GET request on a mandate.
*/
public Map
- *
*/
public ResourceType getResourceType() {
@@ -175,8 +187,9 @@ public Boolean getMandatory() {
}
/**
- * See [here](#core-endpoints-customer-notifications) for a complete list of customer
- * notification types.
+ * See here
+ * for a complete list of customer notification types.
*/
public String getType() {
return type;
@@ -206,32 +219,32 @@ private Details() {
private Boolean willAttemptRetry;
/**
- * When we send a creditor `new_payout_currency_added` webhook, we also send the bank
- * account id of the new account
+ * When we send a creditor billing_requestscreditorsexportsinstalment_schedulesmandatespayer_authorisationspaymentspayoutsrefundsscheme_identifierssubscriptionsoutbound_paymentspayment_account_transactionsnew_payout_currency_added webhook, we also send the
+ * bank account id of the new account
*/
public String getBankAccountId() {
return bankAccountId;
}
/**
- * What triggered the event. _Note:_ `cause` is our simplified and predictable key
- * indicating what triggered the event.
+ * What triggered the event. Note: cause is our simplified and
+ * predictable key indicating what triggered the event.
*/
public String getCause() {
return cause;
}
/**
- * When we send a creditor `new_payout_currency_added` webhook, we also send the currency of
- * the new account
+ * When we send a creditor new_payout_currency_added webhook, we also send the
+ * currency of the new account
*/
public String getCurrency() {
return currency;
}
/**
- * Human readable description of the cause. _Note:_ Changes to event descriptions are not
- * considered breaking.
+ * Human readable description of the cause. Note: Changes to event descriptions are
+ * not considered breaking.
*/
public String getDescription() {
return description;
@@ -247,10 +260,12 @@ public Integer getItemCount() {
/**
* When will_attempt_retry is set to false, this field will contain the reason the payment
* was not retried. This can be one of:
+ *
*
- *
*/
public String getNotRetriedReason() {
@@ -259,12 +274,13 @@ public String getNotRetriedReason() {
/**
* Who initiated the event. One of:
+ *
* failure_filter_applied: The payment won't be intelligently retried as
+ * there is a high likelihood of failure on retry.other: The payment won't be intelligently retried due to any other
+ * reason.
- *
*/
public Origin getOrigin() {
@@ -272,19 +288,20 @@ public Origin getOrigin() {
}
/**
- * When we send a creditor `creditor_updated` webhook, this tells you which property on the
- * creditor has been updated
+ * When we send a creditor bank: this event was triggered by a report from the banksgocardless: this event was performed by GoCardless automaticallyapi: this event was triggered by an API endpointcustomer: this event was triggered by a Customerpayer: this event was triggered by a Payercreditor_updated webhook, this tells you which
+ * property on the creditor has been updated
*/
public String getProperty() {
return property;
}
/**
- * Set when a `bank` is the origin of the event. This is the reason code received in the
- * report from the customer's bank. See the [GoCardless Direct Debit
- * guide](https://gocardless.com/direct-debit/receiving-messages) for information on the
- * meanings of different reason codes. _Note:_ `reason_code` is payment scheme-specific and
- * can be inconsistent between banks.
+ * Set when a bank is the origin of the event. This is the reason code received
+ * in the report from the customer's bank. See the
+ * GoCardless Direct Debit
+ * guide for information on the meanings of different reason codes. Note:
+ * reason_code is payment scheme-specific and can be inconsistent between
+ * banks.
*/
public String getReasonCode() {
return reasonCode;
@@ -367,59 +384,72 @@ private Links() {
private String subscription;
/**
- * ID of a [bank authorisation](#billing-requests-bank-authorisations).
+ * ID of a bank
+ * authorisation.
*/
public String getBankAuthorisation() {
return bankAuthorisation;
}
/**
- * ID of a [billing request](#billing-requests-billing-requests).
+ * ID of a billing
+ * request.
*/
public String getBillingRequest() {
return billingRequest;
}
/**
- * ID of a [billing request flow](#billing-requests-billing-request-flows).
+ * ID of a billing
+ * request flow.
*/
public String getBillingRequestFlow() {
return billingRequestFlow;
}
/**
- * If `resource_type` is `creditor`, this is the ID of the
- * [creditor](#core-endpoints-creditors) 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](#core-endpoints-customers).
+ * ID of a customer.
*/
public String getCustomer() {
return customer;
}
/**
- * ID of a [customer bank account](#core-endpoints-customer-bank-accounts).
+ * ID of a customer
+ * bank account.
*/
public String getCustomerBankAccount() {
return customerBankAccount;
}
/**
- * If `resource_type` is `instalment_schedule`, this is the ID of the [instalment
- * schedule](#core-endpoints-instalment-schedules) which has been updated.
+ * If resource_type is instalment_schedule, this is the ID of the
+ * instalment
+ * schedule which has been updated.
*/
public String getInstalmentSchedule() {
return instalmentSchedule;
}
/**
- * If `resource_type` is `mandates`, this is the ID of the
- * [mandate](#core-endpoints-mandates) 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;
@@ -433,41 +463,46 @@ public String getMandateRequest() {
}
/**
- * If `resource_type` is `billing_requests`, this is the ID of the
- * [mandate](#core-endpoints-mandates) which has been created.
+ * If resource_type is billing_requests, this is the ID of the
+ * 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
- * bank account](#core-endpoints-customer-bank-accounts) which the mandate is being
- * transferred to.
+ * 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() {
return newCustomerBankAccount;
}
/**
- * This is only included for mandate replaced events, when it is the ID of the new
- * [mandate](#core-endpoints-mandates) 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;
}
/**
- * If the event is included in a [webhook](#webhooks-overview) to an [OAuth
- * app](#appendix-oauth), this is the ID of the account to which it belongs.
+ * If the event is included in a
+ * webhook
+ * to an OAuth
+ * app, this is the ID of the account to which it belongs.
*/
public String getOrganisation() {
return organisation;
}
/**
- * If `resource_type` is `outbound_payments`, this is the ID of the outbound_payment which
- * has been updated.
+ * If resource_type is outbound_payments, this is the ID of the
+ * outbound_payment which has been updated.
*/
public String getOutboundPayment() {
return outboundPayment;
@@ -484,72 +519,83 @@ public String getParentEvent() {
}
/**
- * ID of a [payer authorisation](#core-endpoints-payer-authorisations).
+ * ID of a payer
+ * authorisation.
*/
public String getPayerAuthorisation() {
return payerAuthorisation;
}
/**
- * If `resource_type` is `payments`, this is the ID of the
- * [payment](#core-endpoints-payments) 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;
}
/**
- * If `resource_type` is `payment_account_transaction`, this is the ID of a transaction
- * which has been recorded on the payment account.
+ * If resource_type is payment_account_transaction, this is the ID
+ * of a transaction which has been recorded on the payment account.
*/
public String getPaymentAccountTransaction() {
return paymentAccountTransaction;
}
/**
- * If `resource_type` is `billing_requests`, this is the ID of the
- * [payment](#core-endpoints-payments) which has been created for Pay by Bank.
+ * If resource_type is billing_requests, this is the ID of the
+ * 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](#core-endpoints-payouts)
- * 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
- * bank account](#core-endpoints-customer-bank-accounts) which the mandate is being
- * transferred from.
+ * 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() {
return previousCustomerBankAccount;
}
/**
- * If `resource_type` is `refunds`, this is the ID of the [refund](#core-endpoints-refunds)
- * 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;
}
/**
- * If `resource_type` is `scheme_identifiers`, this is the ID of the
- * [scheme_identifier](#core-endpoints-scheme-identifiers) which has been updated.
+ * If resource_type is scheme_identifiers, this is the ID of the
+ * scheme_identifier
+ * which has been updated.
*/
public String getSchemeIdentifier() {
return schemeIdentifier;
}
/**
- * If `resource_type` is `subscription`, this is the ID of the
- * [subscription](#core-endpoints-subscriptions) which has been updated.
+ * If resource_type is subscription, this is the ID of the
+ * subscription
+ * which has been updated.
*/
public String getSubscription() {
return subscription;
diff --git a/src/main/java/com/gocardless/resources/Export.java b/src/main/java/com/gocardless/resources/Export.java
index fea0bb16..77418503 100644
--- a/src/main/java/com/gocardless/resources/Export.java
+++ b/src/main/java/com/gocardless/resources/Export.java
@@ -20,7 +20,9 @@ private Export() {
private String id;
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -85,7 +87,8 @@ public enum ExportType {
GC_INVALID_AUTHORISATION_REQUESTS, @SerializedName("partner_fees")
PARTNER_FEES, @SerializedName("payments_import_template")
PAYMENTS_IMPORT_TEMPLATE, @SerializedName("payment_account_statement")
- PAYMENT_ACCOUNT_STATEMENT, @SerializedName("unknown")
+ PAYMENT_ACCOUNT_STATEMENT, @SerializedName("outbound_payments_index")
+ OUTBOUND_PAYMENTS_INDEX, @SerializedName("unknown")
UNKNOWN
}
}
diff --git a/src/main/java/com/gocardless/resources/InstalmentSchedule.java b/src/main/java/com/gocardless/resources/InstalmentSchedule.java
index 9d53f9c1..0673dda3 100644
--- a/src/main/java/com/gocardless/resources/InstalmentSchedule.java
+++ b/src/main/java/com/gocardless/resources/InstalmentSchedule.java
@@ -8,16 +8,15 @@
* Represents a instalment schedule resource returned from the API.
*
* Instalment schedules are objects which represent a collection of related payments, with the
- * intention to collect the `total_amount` specified. The API supports both schedule-based creation
- * (similar to subscriptions) as well as explicit selection of differing payment amounts and charge
- * dates.
+ * intention to collect the total_amount specified. The API supports both
+ * schedule-based creation (similar to subscriptions) as well as explicit selection of differing
+ * payment amounts and charge dates.
*
* Unlike subscriptions, the payments are created immediately, so the instalment schedule cannot be
* modified once submitted and instead can only be cancelled (which will cancel any of the payments
* which have not yet been submitted).
*
* Customers will receive a single notification about the complete schedule of collection.
- *
*/
public class InstalmentSchedule {
private InstalmentSchedule() {
@@ -35,15 +34,17 @@ private InstalmentSchedule() {
private Integer totalAmount;
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public Currency getCurrency() {
return currency;
@@ -80,9 +81,9 @@ public String getName() {
}
/**
- * If the status is `creation_failed`, this property will be populated with validation failures
- * from the individual payments, arranged by the index of the payment that failed.
- *
+ * If the status is creation_failed, this property will be populated with
+ * validation failures from the individual payments, arranged by the index of the payment that
+ * failed.
*/
public Map
- *
*/
public Status getStatus() {
@@ -152,22 +154,25 @@ private Links() {
private Listpending: we're waiting for GC to create the paymentsactive: the payments have been created, and the schedule is activecreation_failed: payment creation failedcompleted: we have passed the date of the final payment and all payments
+ * have been collectedcancelled: the schedule has been cancellederrored: one or more payments have failed
+ *
*/
public FundsSettlement getFundsSettlement() {
return fundsSettlement;
@@ -109,17 +114,17 @@ public Mapmanaged will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the merchant
+ * where invoicing will be handled separately.charge_date on any newly created payment
+ * for this mandate. This value will change over time.
*/
public String getNextPossibleChargeDate() {
return nextPossibleChargeDate;
}
/**
- * If this is an an ACH mandate, the earliest date that can be used as a `charge_date` on any
- * newly created payment to be charged through standard ACH, rather than Faster ACH. This value
- * will change over time.
+ * If this is an an ACH mandate, the earliest date that can be used as a
+ * charge_date on any newly created payment to be charged through standard ACH,
+ * rather than Faster ACH. This value will change over time.
*
* It is only present in the API response for ACH mandates.
*/
@@ -136,9 +141,10 @@ public Boolean getPaymentsRequireApproval() {
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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;
@@ -155,20 +161,22 @@ public String getScheme() {
/**
* One of:
+ *
*
- *
*/
public Status getStatus() {
@@ -176,7 +184,9 @@ public Status getStatus() {
}
/**
- * [Timestamp](#api-usage-dates-and-times) recording when this mandate was verified.
+ * Timestamp
+ * recording when this mandate was verified.
*/
public String getVerifiedAt() {
return verifiedAt;
@@ -318,22 +328,25 @@ private Links() {
private String newMandate;
/**
- * ID of the associated [creditor](#core-endpoints-creditors).
+ * ID of the associated creditor.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of the associated [customer](#core-endpoints-customers)
+ * ID of the associated customer
*/
public String getCustomer() {
return customer;
}
/**
- * ID of the associated [customer bank account](#core-endpoints-customer-bank-accounts)
- * which the mandate is created and submits payments against.
+ * ID of the associated customer
+ * bank account which the mandate is created and submits payments against.
*/
public String getCustomerBankAccount() {
return customerBankAccount;
diff --git a/src/main/java/com/gocardless/resources/MandateImport.java b/src/main/java/com/gocardless/resources/MandateImport.java
index 502b82f8..038b944e 100644
--- a/src/main/java/com/gocardless/resources/MandateImport.java
+++ b/src/main/java/com/gocardless/resources/MandateImport.java
@@ -10,27 +10,40 @@
*
* The process is as follows:
*
- * 1. [Create a mandate import](#mandate-imports-create-a-new-mandate-import) 2. [Add
- * entries](#mandate-import-entries-add-a-mandate-import-entry) to the import 3.
- * [Submit](#mandate-imports-submit-a-mandate-import) the import 4. Wait until a member of the
- * GoCardless team approves the import, at which point the mandates will be created 5. [Link up the
- * mandates](#mandate-import-entries-list-all-mandate-import-entries) in your system
- *
+ * pending_customer_approval: the mandate has not yet been signed by the second
* customerpending_submission: the mandate has not yet been submitted to the customer's
+ * banksubmitted: the mandate has been submitted to the customer's bank but has not
+ * been processed yetactive: the mandate has been successfully set up by the customer's banksuspended_by_payer: the mandate has been suspended by payerfailed: the mandate could not be createdcancelled: the mandate has been cancelledexpired: the mandate has expired due to dormancyconsumed: the mandate has been consumed and cannot be reused (note that this
+ * only applies to schemes that are per-payment authorised)blocked: the mandate has been blocked and payments cannot be created
+ *
* When you add entries to your mandate import, they are not turned into actual mandates until the
* mandate import is submitted by you via the API, and then processed by a member of the GoCardless
* team. When that happens, a mandate will be created for each entry in the import.
*
- * We will issue a `mandate_created` webhook for each entry, which will be the same as the webhooks
- * triggered when [ creating a mandate ](#mandates-create-a-mandate) using the mandates API. Once
- * these webhooks start arriving, any reconciliation can now be accomplished by [checking the
- * current status](#mandate-imports-get-a-mandate-import) of the mandate import and [linking up the
- * mandates to your system](#mandate-import-entries-list-all-mandate-import-entries).
+ * We will issue a mandate_created webhook for each entry, which will be the same as
+ * the webhooks triggered when
+ * 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
+ * up the mandates to your system.
*
*
+ *
* All mandates in a single mandate import must be for the same scheme.
*/
public Scheme getScheme() {
@@ -78,15 +94,18 @@ public Scheme getScheme() {
/**
* The status of the mandate import.
+ *
*
- *
*/
public Status getStatus() {
diff --git a/src/main/java/com/gocardless/resources/MandateImportEntry.java b/src/main/java/com/gocardless/resources/MandateImportEntry.java
index b9557672..32156a6a 100644
--- a/src/main/java/com/gocardless/resources/MandateImportEntry.java
+++ b/src/main/java/com/gocardless/resources/MandateImportEntry.java
@@ -5,23 +5,26 @@
/**
* Represents a mandate import entry resource returned from the API.
*
- * Mandate Import Entries are added to a [Mandate Import](#core-endpoints-mandate-imports). Each
- * entry corresponds to one mandate to be imported into GoCardless.
+ * Mandate Import Entries are added to a
+ * Mandate
+ * Import. Each entry corresponds to one mandate to be imported into GoCardless.
*
* To import a mandate you will need:
+ *
* created: A new mandate import.submitted: After the integrator has finished adding mandates and submitted
+ * the import.cancelled: If the integrator 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.processed: When all mandates have been imported successfully.
*
- *
- * 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 the mandate import
- * entries](#mandate-import-entries-list-all-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.
+ * 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
+ * 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.
*
* url will expire (10 minutes after the original
+ * request).
*/
public String getExpiresAt() {
return expiresAt;
@@ -23,8 +25,8 @@ public String getExpiresAt() {
/**
* The URL at which this mandate PDF can be viewed until it expires at the date and time
- * specified by `expires_at`. You should not store this URL or rely on its structure remaining
- * the same.
+ * specified by expires_at. You should not store this URL or rely on its structure
+ * remaining the same.
*/
public String getUrl() {
return url;
diff --git a/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java b/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
index cdf490ce..1f218606 100644
--- a/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
+++ b/src/main/java/com/gocardless/resources/NegativeBalanceLimit.java
@@ -8,7 +8,6 @@
* The negative balance limit is a threshold for the creditor balance beyond which refunds are not
* permitted. The default limit is zero — refunds are not permitted if the creditor has a negative
* balance. The limit can be changed on a per-creditor basis.
- *
*/
public class NegativeBalanceLimit {
private NegativeBalanceLimit() {
@@ -29,15 +28,17 @@ public Integer getBalanceLimit() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this limit was created.
+ * Fixed timestamp,
+ * recording when this limit was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public Currency getCurrency() {
return currency;
@@ -88,7 +89,9 @@ public String getCreatorUser() {
}
/**
- * ID of [creditor](#core-endpoints-creditors) which this limit relates to
+ * ID of creditor
+ * which this limit relates to
*/
public String getCreditor() {
return creditor;
diff --git a/src/main/java/com/gocardless/resources/OutboundPayment.java b/src/main/java/com/gocardless/resources/OutboundPayment.java
index 0be6d4c9..9d680c17 100644
--- a/src/main/java/com/gocardless/resources/OutboundPayment.java
+++ b/src/main/java/com/gocardless/resources/OutboundPayment.java
@@ -6,18 +6,23 @@
/**
* Represents a outbound payment resource returned from the API.
*
- * Outbound Payments represent payments sent from [creditors](#core-endpoints-creditors).
+ * Outbound Payments represent payments sent from
+ * creditors.
*
- * GoCardless will notify you via a [webhook](#appendix-webhooks) when the status of the outbound
- * payment [changes](#event-types-outbound-payment).
+ * GoCardless will notify you via a
+ * webhook when the
+ * status of the outbound payment changes.
*
- * ####Rate limiting
+ * Rate limiting
Two rate limits apply to the Outbound Payments APIs:
*
- * Two rate limits apply to the Outbound Payments APIs: - All POST Outbound Payment endpoints
- * (create, withdraw, approve, cancel and etc.) share a single rate-limit group of 300 requests per
- * minute. As initiating a payment typically requires two API calls (one to create the payment and
- * one to approve it), this allows you to add approximately 150 outbound payments per minute. - All
- * remaining Outbound Payment endpoints are limited to 500 requests per minute.
+ *
+ *
*/
public class OutboundPayment {
private OutboundPayment() {
@@ -46,16 +51,17 @@ public Integer getAmount() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when the outbound payment was
- * created.
+ * Fixed timestamp,
+ * recording when the outbound payment was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. Currently only
- * "GBP" is supported.
+ * ISO 4217 currency.
+ * Currently only "GBP" is supported.
*/
public Currency getCurrency() {
return currency;
@@ -105,9 +111,15 @@ public Map
- * Faster Payments - 18 characters, including:
- * "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ * for this reference is dependent on the scheme.
+ *
+ * Faster Payments
+ *
+ *
+ *
+ *
*/
public String getReference() {
return reference;
@@ -123,23 +135,26 @@ public Scheme getScheme() {
/**
* One of:
+ *
*
- *
*/
@@ -201,7 +216,9 @@ public String getCreditor() {
}
/**
- * ID of the [customer](#core-endpoints-customers) that receives this outbound payment
+ * ID of the customer
+ * that receives this outbound payment
*/
public String getCustomer() {
return customer;
@@ -265,15 +282,16 @@ public String getActualAccountName() {
/**
* Result of the verification, could be one of
+ *
* verifying: The payment has been created
+ * and the verification process has begun.pending_approval: The payment is awaiting approval.scheduled: The payment has passed verification & 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
+ * or was not approved
+ * on time.failed: The payment was not sent, usually due to an error while or after
* executing.
- *
*/
public Result getResult() {
@@ -281,8 +299,9 @@ public Result getResult() {
}
/**
- * Type of the verification that has been performed eg. [Confirmation of
- * Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/)
+ * Type of the verification that has been performed eg. Confirmation
+ * of Payee
*/
public Type getType() {
return type;
diff --git a/src/main/java/com/gocardless/resources/OutboundPaymentImport.java b/src/main/java/com/gocardless/resources/OutboundPaymentImport.java
index c7303747..2a175ca5 100644
--- a/src/main/java/com/gocardless/resources/OutboundPaymentImport.java
+++ b/src/main/java/com/gocardless/resources/OutboundPaymentImport.java
@@ -7,10 +7,15 @@
*
* Outbound Payment Imports allow you to create multiple payments via a single API call.
*
- * The Workflow: 1. Create the outbound payment import. 2. Retrieve an authorisation link from the
- * response. 3. Redirect the user to the link to authorise the import. 4. Once the user authorises
- * the import, the individual outbound payments are automatically submitted.
+ * The Workflow:
*
+ * full_match: The verification has confirmed that the account name
+ * exactly matches the details provided.partial_match: The verification has confirmed that the account name
+ * is similar but does not match to the details provided.no_match: The verification concludes the provided name does not
+ * match the account details.unable_to_match: The verification could not be performed due to
+ * recipient bank issues or technical issues
+ *
* Import entries are not processed as actual payments until they are reviewed and authorised in
* GoCardless Dashboard. Upon approval, a unique outbound payment is generated for every entry in
* the import.
@@ -50,15 +55,17 @@ public String getAuthorisationUrl() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. Currently only
- * "GBP" is supported.
+ * ISO 4217 currency.
+ * Currently only "GBP" is supported.
*/
public Currency getCurrency() {
return currency;
@@ -81,15 +88,17 @@ public Links getLinks() {
/**
* The status of the outbound payment import.
+ *
*
- *
*/
public Status getStatus() {
diff --git a/src/main/java/com/gocardless/resources/OutboundPaymentImportEntry.java b/src/main/java/com/gocardless/resources/OutboundPaymentImportEntry.java
index f82c6950..b9d71c55 100644
--- a/src/main/java/com/gocardless/resources/OutboundPaymentImportEntry.java
+++ b/src/main/java/com/gocardless/resources/OutboundPaymentImportEntry.java
@@ -34,7 +34,9 @@ public Integer getAmount() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -60,7 +62,9 @@ public Mapcreated: The initial state of a new import.validating: Import validation in progress.invalid: Import validation failed.valid: Import validation succeeded.processing: Authorisation received; payments are being generated.processed: All entries have been successfully converted into outbound
+ * payments.cancelled: The import was cancelled by a user or automatically expired by
+ * the system.
+ *
* After the Payer Authorisation is confirmed, resources will eventually be created as it's an
* asynchronous process.
*
* To retrieve the status and ID of the linked resources you can do one of the following:
+ *
*
- *
- *
* payer_authorisation_completed
- * webhook (recommended) payer_authorisation_completed
+ * webhook
+ * (recommended)https://api.gocardless.com/events?payer_authorisation={id}&action=completedhttps://api.gocardless.com/events?payer_authorisation={id}&action=completedcreate and update endpoints behave differently than other
+ * existing create and update endpoints. The Payer Authorisation is still
+ * saved if incomplete data is provided. We return the list of incomplete data in the
+ * incomplete_fields along with the resources in the body of the response. The bank
+ * account details(account_number, bank_code & branch_code) must be sent together rather than
+ * splitting across different request for both create and update
* endpoints.
+ *
*
+ *
* The API is designed to be flexible and allows you to collect information in multiple steps
* without storing any sensitive data in the browser or in your servers.
*
- *
*/
public Status getStatus() {
@@ -143,8 +157,9 @@ public enum Status {
/**
* Represents a bank account resource returned from the API.
*
- * All details required for the creation of a [Customer Bank
- * Account](#core-endpoints-customer-bank-accounts).
+ * All details required for the creation of a Customer
+ * Bank Account.
*/
public static class BankAccount {
private BankAccount() {
@@ -167,16 +182,18 @@ private BankAccount() {
* Name of the account holder, as known by the bank. The full name provided when the
* 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 bank account
- * token](#javascript-flow-customer-bank-account-tokens).
+ * unless the request includes a customer
+ * bank account token.
*/
public String getAccountHolderName() {
return accountHolderName;
}
/**
- * Bank account number - see [local details](#appendix-local-bank-details) for more
- * information. Alternatively you can provide an `iban`.
+ * Bank account number - see local
+ * details for more information. Alternatively you can provide an created: The PayerAuthorisation has been created, and not been confirmed
+ * yetsubmitted: The payer information has been submittedconfirmed: PayerAuthorisation is confirmed and resources are ready to be
* createdcompleted: The PayerAuthorisation has been completed and customer,
+ * bank_account and mandate has been createdfailed: The PayerAuthorisation has failed and customer, bank_account and
+ * mandate is not creatediban.
*/
public String getAccountNumber() {
return accountNumber;
@@ -191,8 +208,9 @@ public String getAccountNumberEnding() {
}
/**
- * Account number suffix (only for bank accounts denominated in NZD) - see [local
- * details](#local-bank-details-new-zealand) for more information.
+ * Account number suffix (only for bank accounts denominated in NZD) - see local
+ * details for more information.
*/
public String getAccountNumberSuffix() {
return accountNumberSuffix;
@@ -200,50 +218,57 @@ public String getAccountNumberSuffix() {
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
- * bank accounts in other currencies. See [local details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public AccountType getAccountType() {
return accountType;
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public String getBankCode() {
return bankCode;
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public String getBranchCode() {
return branchCode;
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
- * denominated in SEK - you must supply [local details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public String getIban() {
return iban;
@@ -268,7 +293,8 @@ public enum AccountType {
/**
* Represents a customer resource returned from the API.
*
- * All details required for the creation of a [Customer](#core-endpoints-customers).
+ * All details required for the creation of a Customer.
*/
public static class Customer {
private Customer() {
@@ -320,18 +346,20 @@ public String getCity() {
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are provided.
- * For Canadian customers, the use of a `company_name` value will mean that any mandate
- * created from this customer will be considered to be a "Business PAD" (otherwise, any
- * mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered to
+ * be a "Personal PAD").
*/
public String getCompanyName() {
return companyName;
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public String getCountryCode() {
return countryCode;
@@ -354,23 +382,22 @@ public String getEmail() {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public String getFamilyName() {
return familyName;
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public String getGivenName() {
return givenName;
}
/**
- * An [IETF Language Tag](https://tools.ietf.org/html/rfc5646), used for both language and
- * regional variations of our product.
- *
+ * An IETF Language Tag, used for both
+ * language and regional variations of our product.
*/
public String getLocale() {
return locale;
@@ -393,8 +420,8 @@ public String getPostalCode() {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public String getRegion() {
return region;
@@ -486,7 +513,8 @@ public String getMandate() {
/**
* Represents a mandate resource returned from the API.
*
- * All details required for the creation of a [Mandate](#core-endpoints-mandates).
+ * All details required for the creation of a Mandate.
*/
public static class Mandate {
private Mandate() {
@@ -511,18 +539,18 @@ public Mapauthorisation_source is set
+ * to telephone or paper.
*/
public String getPayerIpAddress() {
return payerIpAddress;
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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 dc9ea978..6979116c 100644
--- a/src/main/java/com/gocardless/resources/Payment.java
+++ b/src/main/java/com/gocardless/resources/Payment.java
@@ -6,12 +6,16 @@
/**
* Represents a payment resource returned from the API.
*
- * Payment objects represent payments from a [customer](#core-endpoints-customers) to a
- * [creditor](#core-endpoints-creditors), taken against a Direct Debit
- * [mandate](#core-endpoints-mandates).
+ * Payment objects represent payments from a
+ * customer
+ * to a
+ * creditor,
+ * taken against a Direct Debit
+ * mandate.
*
- * GoCardless will notify you via a [webhook](#appendix-webhooks) whenever the state of a payment
- * changes.
+ * GoCardless will notify you via a
+ * webhook whenever
+ * the state of a payment changes.
*/
public class Payment {
private Payment() {
@@ -36,14 +40,22 @@ private Payment() {
/**
* Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
+ *
+ * Minimum and maximum amounts vary by payment scheme. For more information, see Transaction
+ * limits
+ *
+ * For Variable Recurring Payments (VRP), this must not exceed the mandate's
+ * max_amount_per_payment constraint.
*/
public Integer getAmount() {
return amount;
}
/**
- * Amount [refunded](#core-endpoints-refunds), in the lowest denomination for the currency (e.g.
- * pence in GBP, cents in EUR).
+ * Amount refunded, in the
+ * lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*/
public Integer getAmountRefunded() {
return amountRefunded;
@@ -51,24 +63,27 @@ public Integer getAmountRefunded() {
/**
* 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](#core-endpoints-mandates)'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.
+ * 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.
*/
public String getChargeDate() {
return chargeDate;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public Currency getCurrency() {
return currency;
@@ -77,7 +92,9 @@ 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 requirements](#appendix-compliance-requirements)).
+ * (see compliance
+ * requirements).
*/
public String getDescription() {
return description;
@@ -117,25 +134,76 @@ public Map
- * ACH - 10 characters
- * Autogiro - 11 characters
- * Bacs - 10 characters
- * BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
- * Faster Payments - 18 characters
- * PAD - scheme doesn't offer references
- * PayTo - 18 characters
- * SEPA - 140 characters
+ * for this reference is dependent on the scheme.
+ *
+ * ACH
+ *
+ *
+ *
+ *
+ * Autogiro
+ *
+ *
+ *
+ *
+ * Bacs
+ *
+ *
+ *
+ *
+ * BECS
+ *
+ *
+ *
+ *
+ * BECS NZ
+ *
+ *
+ *
+ *
+ * Betalingsservice
+ *
+ *
+ *
+ *
+ * Faster Payments
+ *
+ *
+ *
+ *
+ * PAD
+ *
+ *
+ *
+ *
+ * PayTo
+ *
+ *
+ *
+ *
+ * SEPA
+ *
+ *
+ *
+ *
* Note that this reference must be unique (for each merchant) for the BECS scheme as it is a
* scheme requirement.
- * false.
*
- *
*/
public Status getStatus() {
@@ -228,35 +300,37 @@ private Fx() {
private FxCurrency fxCurrency;
/**
- * Estimated rate that will be used in the foreign exchange of the `amount` into the
- * `fx_currency`. This will vary based on the prevailing market rate until the moment that
- * it is paid out. Present only before a resource is paid out. Has up to 10 decimal places.
+ * Estimated rate that will be used in the foreign exchange of the pending_customer_approval: we're waiting for the customer to approve this
+ * paymentpending_submission: the payment has been created, but not yet submitted to
+ * the bankssubmitted: the payment has been submitted to the banksconfirmed: the payment has been confirmed as collectedpaid_out: the payment has been included in a payoutcancelled: the payment has been cancelledcustomer_approval_denied: the customer has denied approval for the payment.
+ * You should contact the customer directlyfailed: the payment failed to be processed. Note that payments can fail
+ * after being confirmed if the failure message is sent late by the banks.charged_back: the payment has been charged backamount into
+ * the fx_currency. This will vary based on the prevailing market rate until
+ * the moment that it is paid out. Present only before a resource is paid out. Has up to 10
+ * decimal places.
*/
public String getEstimatedExchangeRate() {
return estimatedExchangeRate;
}
/**
- * Rate used in the foreign exchange of the `amount` into the `fx_currency`. Present only
- * after a resource is paid out. Has up to 10 decimal places.
+ * Rate used in the foreign exchange of the amount into the
+ * fx_currency. Present only after a resource is paid out. Has up to 10 decimal
+ * places.
*/
public String getExchangeRate() {
return exchangeRate;
}
/**
- * Amount that was paid out in the `fx_currency` after foreign exchange. Present only after
- * the resource has been paid out.
+ * Amount that was paid out in the fx_currency after foreign exchange. Present
+ * only after the resource has been paid out.
*/
public Integer getFxAmount() {
return fxAmount;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK",
- * "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or
- * were) made via foreign exchange.
+ * ISO 4217 code for the
+ * currency in which amounts will be paid out (after foreign exchange). Currently "AUD",
+ * "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts
+ * will be (or were) made via foreign exchange.
*/
public FxCurrency getFxCurrency() {
return fxCurrency;
@@ -293,33 +367,41 @@ private Links() {
private String subscription;
/**
- * ID of [creditor](#core-endpoints-creditors) to which the collected payment will be sent.
+ * ID of creditor
+ * to which the collected payment will be sent.
*/
public String getCreditor() {
return creditor;
}
/**
- * ID of [instalment_schedule](#core-endpoints-instalment-schedules) from which this payment
- * was created.
- * **Note**: this property will only be present if this payment is part of an instalment
- * schedule.
+ * ID of instalment_schedule
+ * from which this payment was created.
+ *
+ * Note: this property will only be present if this payment is part of an
+ * instalment schedule.
*/
public String getInstalmentSchedule() {
return instalmentSchedule;
}
/**
- * ID of the [mandate](#core-endpoints-mandates) against which this payment should be
- * collected.
+ * ID of the mandate
+ * against which this payment should be collected.
*/
public String getMandate() {
return mandate;
}
/**
- * ID of [payout](#core-endpoints-payouts) which contains the funds from this payment.
- * _Note_: this property will not be present until the payment has been successfully
+ * ID of payout which
+ * contains the funds from this payment.
+ *
+ * Note: this property will not be present until the payment has been successfully
* collected.
*/
public String getPayout() {
@@ -327,9 +409,12 @@ public String getPayout() {
}
/**
- * ID of [subscription](#core-endpoints-subscriptions) from which this payment was
- * created.
- * _Note_: this property will only be present if this payment is part of a subscription.
+ * ID of subscription
+ * from which this payment was created.
+ *
+ * Note: this property will only be present if this payment is part of a
+ * subscription.
*/
public String getSubscription() {
return subscription;
diff --git a/src/main/java/com/gocardless/resources/PaymentAccount.java b/src/main/java/com/gocardless/resources/PaymentAccount.java
index 70942fcd..3a8d0bd9 100644
--- a/src/main/java/com/gocardless/resources/PaymentAccount.java
+++ b/src/main/java/com/gocardless/resources/PaymentAccount.java
@@ -3,8 +3,9 @@
/**
* 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](#core-endpoints-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() {
@@ -29,8 +30,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](#core-endpoints-creditors). 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;
@@ -52,8 +54,8 @@ public String getBankName() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public String getCurrency() {
return currency;
@@ -83,7 +85,9 @@ private Links() {
private String creditor;
/**
- * ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
+ * ID of the creditor
+ * that owns this bank account.
*/
public String getCreditor() {
return creditor;
diff --git a/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java b/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
index 621511fd..32c2b8ad 100644
--- a/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
+++ b/src/main/java/com/gocardless/resources/PaymentAccountTransaction.java
@@ -6,8 +6,9 @@
* 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](#core-endpoints-outbound-payments).
+ * account is provisioned by GoCardless and is used to fund outbound
+ * payments.
*/
public class PaymentAccountTransaction {
private PaymentAccountTransaction() {
@@ -123,7 +124,9 @@ private Links() {
private String payout;
/**
- * ID of the [outbound_payment](#core-endpoints-outbound-payments) linked to the transaction
+ * ID of the outbound_payment
+ * linked to the transaction
*/
public String getOutboundPayment() {
return outboundPayment;
@@ -137,7 +140,9 @@ public String getPaymentBankAccount() {
}
/**
- * ID of the [payout](#core-endpoints-payouts) linked to the transaction.
+ * ID of the payout
+ * linked to the transaction.
*/
public String getPayout() {
return payout;
diff --git a/src/main/java/com/gocardless/resources/Payout.java b/src/main/java/com/gocardless/resources/Payout.java
index af3b6ea5..17eed085 100644
--- a/src/main/java/com/gocardless/resources/Payout.java
+++ b/src/main/java/com/gocardless/resources/Payout.java
@@ -6,9 +6,11 @@
/**
* Represents a payout resource returned from the API.
*
- * Payouts represent transfers from GoCardless to a [creditor](#core-endpoints-creditors). Each
- * payout contains the funds collected from one or many [payments](#core-endpoints-payments). All
- * the payments in a payout will have been collected in the same currency. Payouts are created
+ * 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.
*/
public class Payout {
@@ -39,27 +41,29 @@ public Integer getAmount() {
/**
* Date the payout is due to arrive in the creditor's bank account. One of:
+ *
*
- *
- *
*/
public String getArrivalDate() {
return arrivalDate;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public Currency getCurrency() {
return currency;
@@ -67,13 +71,17 @@ public Currency getCurrency() {
/**
* Fees that have already been deducted from the payout amount in minor unit (e.g. pence in GBP,
- * cents in EUR), inclusive of tax if applicable. yyyy-mm-dd: the payout has been paid and is due to arrive in the creditor's
+ * bank account on this daynull: the payout hasn't been paid yet
- * For each `late_failure_settled` or `chargeback_settled` action, we refund the transaction
- * fees in a payout. This means that a payout can have a negative `deducted_fees` value.
- * This field is calculated as `(GoCardless fees + app fees + surcharge fees) - (refunded fees)`
- *
- * If the merchant is invoiced for fees separately from the payout, then `deducted_fees` will be
- * 0.
+ * cents in EUR), inclusive of tax if applicable.
+ *
+ * For each late_failure_settled or chargeback_settled action, we
+ * refund the transaction fees in a payout. This means that a payout can have a negative
+ * deducted_fees value.
+ *
+ * This field is calculated as (GoCardless fees + app fees + surcharge fees) - (refunded
+ * fees)
+ *
+ * If the merchant is invoiced for fees separately from the payout, then
+ * deducted_fees will be 0.
*/
public Integer getDeductedFees() {
return deductedFees;
@@ -96,8 +104,8 @@ public Links getLinks() {
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
- * characters and values up to 500 characters. _Note:_ This should not be used for storing PII
- * data.
+ * characters and values up to 500 characters. Note: This should not be used for
+ * storing PII data.
*/
public Map
- *
*/
public Status getStatus() {
@@ -132,10 +141,10 @@ public Status getStatus() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which tax is paid out to the tax authorities of your tax jurisdiction. Currently “EUR”,
- * “GBP”, for French or British merchants, this will be `null` if tax is not applicable
- * beta
+ * ISO 4217 code for the
+ * currency in which tax is paid out to the tax authorities of your tax jurisdiction. Currently
+ * “EUR”, “GBP”, for French or British merchants, this will be pending: the payout has been created, but not yet sent to your bank or it is
+ * in the process of being exchanged through our FX provider.paid: the payout has been sent to the your bank. FX payouts will become
+ * paid after we emit the fx_rate_confirmed webhook.bounced: the payout bounced when sent, the payout can be retried.null if tax is not
+ * applicable beta
*/
public String getTaxCurrency() {
return taxCurrency;
@@ -185,35 +194,37 @@ private Fx() {
private FxCurrency fxCurrency;
/**
- * Estimated rate that will be used in the foreign exchange of the `amount` into the
- * `fx_currency`. This will vary based on the prevailing market rate until the moment that
- * it is paid out. Present only before a resource is paid out. Has up to 10 decimal places.
+ * Estimated rate that will be used in the foreign exchange of the amount into
+ * the fx_currency. This will vary based on the prevailing market rate until
+ * the moment that it is paid out. Present only before a resource is paid out. Has up to 10
+ * decimal places.
*/
public String getEstimatedExchangeRate() {
return estimatedExchangeRate;
}
/**
- * Rate used in the foreign exchange of the `amount` into the `fx_currency`. Present only
- * after a resource is paid out. Has up to 10 decimal places.
+ * Rate used in the foreign exchange of the amount into the
+ * fx_currency. Present only after a resource is paid out. Has up to 10 decimal
+ * places.
*/
public String getExchangeRate() {
return exchangeRate;
}
/**
- * Amount that was paid out in the `fx_currency` after foreign exchange. Present only after
- * the resource has been paid out.
+ * Amount that was paid out in the fx_currency after foreign exchange. Present
+ * only after the resource has been paid out.
*/
public Integer getFxAmount() {
return fxAmount;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK",
- * "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or
- * were) made via foreign exchange.
+ * ISO 4217 code for the
+ * currency in which amounts will be paid out (after foreign exchange). Currently "AUD",
+ * "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts
+ * will be (or were) made via foreign exchange.
*/
public FxCurrency getFxCurrency() {
return fxCurrency;
@@ -247,15 +258,18 @@ private Links() {
private String creditorBankAccount;
/**
- * ID of [creditor](#core-endpoints-creditors) 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 account](#core-endpoints-creditor-bank-accounts) which this will be sent to.
+ * ID of bank
+ * account which this will be sent to.
*/
public String getCreditorBankAccount() {
return creditorBankAccount;
diff --git a/src/main/java/com/gocardless/resources/PayoutItem.java b/src/main/java/com/gocardless/resources/PayoutItem.java
index 126a3687..46b8c57e 100644
--- a/src/main/java/com/gocardless/resources/PayoutItem.java
+++ b/src/main/java/com/gocardless/resources/PayoutItem.java
@@ -17,7 +17,6 @@
* The Payout Items API allows you to view, on a per-payout basis, the credit and debit items that
* make up that payout's amount. Payout items can only be retrieved for payouts created in the last
* 6 months. Requests for older payouts will return an HTTP status 410 Gone.
- *
*/
public class PayoutItem {
private PayoutItem() {
@@ -32,11 +31,14 @@ private PayoutItem() {
/**
* The positive (credit) or negative (debit) value of the item, in fractional currency; the
* lowest denomination for the currency (e.g. pence in GBP, cents in EUR), to one decimal place.
+ *
*
+ *
*
+ *
* To calculate the final amount of the payout, we sum all of the items and then round to the
* nearest currency unit.
*
- *
- *
*/
public Type getType() {
return type;
@@ -119,8 +122,8 @@ private Links() {
/**
* Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates
- * created before 2016. Present only for the items of type `payment_refunded`, `refund` and
- * `refund_funds_returned`.
+ * created before 2016. Present only for the items of type payment_paid_out (credit)payment_failed (debit): The payment failed to be processed.payment_charged_back (debit): The payment has been charged back.payment_refunded (debit): The payment has been refunded to the
+ * customer.refund (debit): A refund sent to a customer, not linked to a payment.refund_funds_returned (credit): The refund could not be sent to the
+ * customer, and the funds have been returned to you.gocardless_fee (credit/debit): The fees that GoCardless charged for a
+ * payment. In the case of a payment failure or chargeback, these will appear as credits. Will
+ * include taxes if applicable for merchants.app_fee (credit/debit): The optional fees that a partner may have taken for
+ * a payment. In the case of a payment failure or chargeback, these will appear as credits.revenue_share (credit/debit): A share of the fees that GoCardless collected
+ * which some partner integrations receive when their users take payments. Only shown in partner
+ * payouts. In the case of a payment failure or chargeback, these will appear as credits.surcharge_fee (credit/debit): GoCardless deducted a surcharge fee as the
+ * payment failed or was charged back, or refunded a surcharge fee as the bank or customer
+ * cancelled the chargeback. Will include taxes if applicable for merchants.payment_refunded,
+ * refund and refund_funds_returned.
*/
public String getMandate() {
return mandate;
@@ -135,7 +138,8 @@ public String getPayment() {
/**
* Unique identifier, beginning with "RF". Present only for the items of type
- * `payment_refunded`, `refund` and `refund_funds_returned`.
+ * payment_refunded, refund and
+ * refund_funds_returned.
*/
public String getRefund() {
return refund;
@@ -168,8 +172,8 @@ public String getAmount() {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public Currency getCurrency() {
return currency;
@@ -180,17 +184,17 @@ public Currency getCurrency() {
* lowest denomination for the currency (e.g. pence in GBP, cents in EUR), to one decimal
* place.
*
- * When `currency` and `destination_currency` don't match this will be `null` until the
- * `exchange_rate` has been finalised.
+ * When currency and destination_currency don't match this will be
+ * null until the exchange_rate has been finalised.
*/
public String getDestinationAmount() {
return destinationAmount;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which tax is paid out to the tax authorities of your tax jurisdiction. Currently “EUR”
- * for French merchants and “GBP” for British merchants.
+ * ISO 4217 code for the
+ * currency in which tax is paid out to the tax authorities of your tax jurisdiction.
+ * Currently “EUR” for French merchants and “GBP” for British merchants.
*/
public String getDestinationCurrency() {
return destinationCurrency;
@@ -202,9 +206,9 @@ public String getDestinationCurrency() {
* Present only if the currency and the destination currency don't match and the exchange
* rate has been finalised.
*
- * You can listen for the payout's [`tax_exchange_rates_confirmed`
- * webhook](https://developer.gocardless.com/api-reference/#event-types-payout) to know when
- * the exchange rate has been finalised for all fees in the payout.
+ * You can listen for the payout's tax_exchange_rates_confirmed
+ * webhook to know when the exchange rate has been finalised for all fees in the payout.
*/
public String getExchangeRate() {
return exchangeRate;
diff --git a/src/main/java/com/gocardless/resources/RedirectFlow.java b/src/main/java/com/gocardless/resources/RedirectFlow.java
index b5dea604..2ac3b6f4 100644
--- a/src/main/java/com/gocardless/resources/RedirectFlow.java
+++ b/src/main/java/com/gocardless/resources/RedirectFlow.java
@@ -8,35 +8,44 @@
*
*
+ *
+ * Once you have 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.
*
* Redirect flows expire 30 minutes after they are first created. You cannot complete an expired
* redirect flow. For an integrator this is shorter and they will expire after 10 minutes.
@@ -62,7 +71,8 @@ private RedirectFlow() {
* The URL of a confirmation page, which you may optionally redirect the customer to rather than
* use your own page, that confirms in their chosen language that their Direct Debit has been
* set up successfully. Only returned once the customer has set up their mandate via the payment
- * pages and the redirect flow has been [completed](#redirect-flows-complete-a-redirect-flow),
+ * pages and the redirect flow has been 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.
*/
@@ -71,7 +81,9 @@ public String getConfirmationUrl() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -105,8 +117,8 @@ public String getMandateReference() {
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
- * characters and values up to 500 characters. _Note:_ This should not be used for storing PII
- * data.
+ * characters and values up to 500 characters. Note: This should not be used for
+ * storing PII data.
*/
public Maphttps in the live environment.
*/
public String getSuccessRedirectUrl() {
return successRedirectUrl;
@@ -176,46 +188,58 @@ private Links() {
private String mandate;
/**
- * ID of [billing request](#billing-requests-billing-requests) that a redirect flow can
- * create.
- * **Note**: The redirect flow will only create a billing request in the event the redirect
- * flow is eligible to send the payer down this new and improved flow
+ * ID of billing
+ * request that a redirect flow can create.
+ *
+ * Note: The redirect flow will only create a billing request in the event
+ * the redirect flow is eligible to send the payer down this new and improved flow
*/
public String getBillingRequest() {
return billingRequest;
}
/**
- * The [creditor](#core-endpoints-creditors) 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](#core-endpoints-customers) created by this redirect flow.
- * **Note**: this property will not be present until the redirect flow has been successfully
- * completed.
+ * ID of customer
+ * created by this redirect flow.
+ *
+ * Note: this property will not be present until the redirect flow has been
+ * successfully completed.
*/
public String getCustomer() {
return customer;
}
/**
- * ID of [customer bank account](#core-endpoints-customer-bank-accounts) created by this
- * redirect flow.
- * **Note**: this property will not be present until the redirect flow has been successfully
- * completed.
+ * ID of customer
+ * bank account created by this redirect flow.
+ *
+ * Note: this property will not be present until the redirect flow has been
+ * successfully completed.
*/
public String getCustomerBankAccount() {
return customerBankAccount;
}
/**
- * ID of [mandate](#core-endpoints-mandates) created by this redirect flow.
- * **Note**: this property will not be present until the redirect flow has been successfully
- * completed.
+ * ID of mandate
+ * created by this redirect flow.
+ *
+ * Note: this property will not be present until the redirect flow has been
+ * successfully completed.
*/
public String getMandate() {
return mandate;
diff --git a/src/main/java/com/gocardless/resources/Refund.java b/src/main/java/com/gocardless/resources/Refund.java
index cc4dd0fc..fd2e0ba3 100644
--- a/src/main/java/com/gocardless/resources/Refund.java
+++ b/src/main/java/com/gocardless/resources/Refund.java
@@ -6,11 +6,14 @@
/**
* Represents a refund resource returned from the API.
*
- * Refund objects represent (partial) refunds of a [payment](#core-endpoints-payments) back to the
- * [customer](#core-endpoints-customers).
+ * Refund objects represent (partial) refunds of a
+ * payment
+ * back to the
+ * customer.
*
- * GoCardless will notify you via a [webhook](#appendix-webhooks) whenever a refund is created, and
- * will update the `amount_refunded` property of the payment.
+ * GoCardless will notify you via a
+ * webhook whenever
+ * a refund is created, and will update the amount_refunded property of the payment.
*/
public class Refund {
private Refund() {
@@ -35,15 +38,18 @@ public Integer getAmount() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. This is set to
- * the currency of the refund's [payment](#core-endpoints-payments).
+ * ISO 4217 currency code.
+ * This is set to the currency of the refund's payment.
*/
public String getCurrency() {
return currency;
@@ -74,25 +80,76 @@ public Map
- * ACH - 10 characters
- * Autogiro - 11 characters
- * Bacs - 10 characters
- * BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
- * Faster Payments - 18 characters
- * PAD - scheme doesn't offer references
- * PayTo - 18 characters
- * SEPA - 140 characters
+ * for this reference is dependent on the scheme.
+ *
+ * ACH
+ *
+ *
+ *
+ *
+ * Autogiro
+ *
+ *
+ *
+ *
+ * Bacs
+ *
+ *
+ *
+ *
+ * BECS
+ *
+ *
+ *
+ *
+ * BECS NZ
+ *
+ *
+ *
+ *
+ * Betalingsservice
+ *
+ *
+ *
+ *
+ * Faster Payments
+ *
+ *
+ *
+ *
+ * PAD
+ *
+ *
+ *
+ *
+ * PayTo
+ *
+ *
+ *
+ *
+ * SEPA
+ *
+ *
+ *
+ *
* Note that this reference must be unique (for each merchant) for the BECS scheme as it is a
* scheme requirement.
- *
- *
*/
public Status getStatus() {
@@ -145,35 +204,37 @@ private Fx() {
private FxCurrency fxCurrency;
/**
- * Estimated rate that will be used in the foreign exchange of the `amount` into the
- * `fx_currency`. This will vary based on the prevailing market rate until the moment that
- * it is paid out. Present only before a resource is paid out. Has up to 10 decimal places.
+ * Estimated rate that will be used in the foreign exchange of the created: the refund has been createdpending_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 payoutcancelled: the refund has been cancelledbounced: the refund has failed to be paidfunds_returned: the refund has had its funds returnedamount into
+ * the fx_currency. This will vary based on the prevailing market rate until
+ * the moment that it is paid out. Present only before a resource is paid out. Has up to 10
+ * decimal places.
*/
public String getEstimatedExchangeRate() {
return estimatedExchangeRate;
}
/**
- * Rate used in the foreign exchange of the `amount` into the `fx_currency`. Present only
- * after a resource is paid out. Has up to 10 decimal places.
+ * Rate used in the foreign exchange of the amount into the
+ * fx_currency. Present only after a resource is paid out. Has up to 10 decimal
+ * places.
*/
public String getExchangeRate() {
return exchangeRate;
}
/**
- * Amount that was paid out in the `fx_currency` after foreign exchange. Present only after
- * the resource has been paid out.
+ * Amount that was paid out in the fx_currency after foreign exchange. Present
+ * only after the resource has been paid out.
*/
public Integer getFxAmount() {
return fxAmount;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in
- * which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK",
- * "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or
- * were) made via foreign exchange.
+ * ISO 4217 code for the
+ * currency in which amounts will be paid out (after foreign exchange). Currently "AUD",
+ * "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts
+ * will be (or were) made via foreign exchange.
*/
public FxCurrency getFxCurrency() {
return fxCurrency;
@@ -207,14 +268,18 @@ private Links() {
private String payment;
/**
- * ID of the [mandate](#core-endpoints-mandates) against which the refund is being made.
+ * ID of the mandate
+ * against which the refund is being made.
*/
public String getMandate() {
return mandate;
}
/**
- * ID of the [payment](#core-endpoints-payments) against which the refund is being made.
+ * ID of the payment
+ * against which the refund is being made.
*/
public String getPayment() {
return payment;
diff --git a/src/main/java/com/gocardless/resources/ScenarioSimulator.java b/src/main/java/com/gocardless/resources/ScenarioSimulator.java
index 23176c2f..c74a1933 100644
--- a/src/main/java/com/gocardless/resources/ScenarioSimulator.java
+++ b/src/main/java/com/gocardless/resources/ScenarioSimulator.java
@@ -15,108 +15,126 @@ private ScenarioSimulator() {
/**
* The unique identifier of the simulator, used to initiate simulations. One of:
+ *
*
- *
*/
public String getId() {
diff --git a/src/main/java/com/gocardless/resources/SchemeIdentifier.java b/src/main/java/com/gocardless/resources/SchemeIdentifier.java
index e3f4655d..cf2644fd 100644
--- a/src/main/java/com/gocardless/resources/SchemeIdentifier.java
+++ b/src/main/java/com/gocardless/resources/SchemeIdentifier.java
@@ -7,7 +7,6 @@
*
* This represents a scheme identifier (e.g. a SUN in Bacs or a CID in SEPA). Scheme identifiers are
* used to specify the beneficiary name that appears on customers' bank statements.
- *
*/
public class SchemeIdentifier {
private SchemeIdentifier() {
@@ -69,15 +68,18 @@ public String getCity() {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public String getCountryCode() {
return countryCode;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
@@ -108,8 +110,9 @@ public String getId() {
* The minimum interval, in working days, between the sending of a pre-notification to the
* customer, and the charge date of a payment using this scheme identifier.
*
- * By default, GoCardless sends these notifications automatically. Please see our [compliance
- * requirements](#appendix-compliance-requirements) for more details.
+ * By default, GoCardless sends these notifications automatically. Please see our compliance
+ * requirements for more details.
*/
public Integer getMinimumAdvanceNotice() {
return minimumAdvanceNotice;
@@ -159,8 +162,8 @@ public Scheme getScheme() {
}
/**
- * The status of the scheme identifier. Only `active` scheme identifiers will be applied to a
- * creditor and used against payments.
+ * The status of the scheme identifier. Only creditor_verification_status_action_required: Sets a creditor's
+ * verification status to action required, meaning that the creditor
+ * must provide further information to GoCardless in order to verify their account to receive
+ * payouts.creditor_verification_status_in_review: Sets a creditor's verification
+ * status to in review, meaning that the creditor has provided all of the
+ * information requested by GoCardless to verify their account, and is now awaiting review.creditor_verification_status_successful: Sets a creditor's
+ * verification
+ * status to successful, meaning that the creditor is fully verified and can
+ * receive payouts.payment_confirmed: Transitions a payment through to confirmed.
+ * It must start in the pending_submission state, and its mandate must be in the
+ * activated state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which
+ * cases the mandate may be pending_submission, since their mandates are submitted
+ * with their first payment).payment_paid_out: Transitions a payment through to paid_out,
+ * having been collected successfully and paid out to you. It must start in the
+ * pending_submission state, and its mandate must be in the activated
+ * state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may
+ * be pending_submission, since their mandates are submitted with their first
+ * payment).payment_failed: Transitions a payment through to failed. It
+ * must start in the pending_submission state, and its mandate must be in the
+ * activated state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which
+ * cases the mandate may be pending_submission, since their mandates are submitted
+ * with their first payment).payment_charged_back: Behaves the same as the payout_paid_out
+ * simulator, except that the payment is transitioned to charged_back after it is
+ * paid out, having been charged back by the customer.payment_chargeback_settled: Behaves the same as the
+ * payment_charged_back simulator, except that the charged back payment is
+ * additionally included as a debit item in a payout, thereby settling the charged back
+ * payment.payment_late_failure: Transitions a payment through to
+ * late_failure, having been apparently collected successfully beforehand. It must
+ * start in either the pending_submission or paid_out state, and its
+ * mandate must be in the activated state (unless it is a payment for ACH, BECS,
+ * BECS_NZ or SEPA, in which cases the mandate may be pending_submission, since
+ * their mandates are submitted with their first payment). Not compatible with Autogiro
+ * mandates.payment_late_failure_settled: Behaves the same as the
+ * payment_late_failure simulator, except that the late failure is additionally
+ * included as a debit item in a payout, thereby settling the late failure.payment_submitted: Transitions a payment to submitted, without
+ * proceeding any further. It must start in the pending_submission state.mandate_activated: Transitions a mandate through to activated,
+ * having been submitted to the banks and set up successfully. It must start in the
+ * pending_submission state. Not compatible with ACH, BECS, BECS_NZ and SEPA
+ * mandates, which are submitted and activated with their first payment.mandate_customer_approval_granted: Transitions a mandate through to
+ * pending_submission, as if the customer approved the mandate creation. It must
+ * start in the pending_customer_approval state. Compatible only with Bacs and SEPA
+ * mandates, which support customer signatures on the mandate. All payments associated with the
+ * mandate will be transitioned to pending_submission. All subscriptions associated
+ * with the mandate will become active.mandate_customer_approval_skipped: Transitions a mandate through to
+ * pending_submission, as if the customer skipped the mandate approval during the
+ * mandate creation process. It must start in the pending_customer_approval state.
+ * Compatible only with Bacs and SEPA mandates, which support customer signatures on the
+ * mandate. All payments associated with the mandate will be transitioned to
+ * pending_submission. All subscriptions associated with the mandate will become
+ * active.mandate_failed: Transitions a mandate through to failed, having
+ * been submitted to the banks but found to be invalid (for example due to invalid bank
+ * details). It must start in the pending_submission or submitted
+ * states. Not compatible with SEPA mandates, which are submitted with their first payment.mandate_expired: Transitions a mandate through to expired,
+ * having been submitted to the banks, set up successfully and then expired because no
+ * collection attempts were made against it for longer than the scheme's dormancy period (13
+ * months for Bacs, 3 years for SEPA, 15 months for ACH, Betalingsservice, and BECS). It must
+ * start in the pending_submission state. Not compatible with Autogiro, BECS NZ,
+ * and PAD mandates, which do not expire.mandate_transferred: Transitions a mandate through to
+ * transferred, having been submitted to the banks, set up successfully and then
+ * moved to a new bank account due. It must start in the pending_submission state.
+ * Only compatible with Bacs and SEPA mandates.mandate_transferred_with_resubmission: Transitions a mandate through
+ * transferred and resubmits it to the banks, can be caused be the UK's Current
+ * Account Switching Service (CASS) or when a customer contacts GoCardless to change their bank
+ * details. It must start in the pending_submission state. Only compatible with
+ * Bacs mandates.mandate_suspended_by_payer: Transitions a mandate to
+ * suspended_by_payer, as if payer has suspended the mandate after it has been
+ * setup successfully. It must start in the activated state. Only compatible with
+ * PAY_TO mandates.refund_paid: Transitions a refund to paid. It must start in
+ * either the pending_submission or submitted state.refund_settled: Transitions a refund to paid, if it's not
+ * already, then generates a payout that includes the refund, thereby settling the funds. It
+ * must start in one of pending_submission, submitted or
+ * paid states.refund_bounced: Transitions a refund to bounced. It must start
+ * in either the pending_submission, submitted, or paid
* state.refund_returned: Transitions a refund to refund_returned. The
+ * refund must start in pending_submission.payout_bounced: Transitions a payout to bounced. It must start
+ * in the paid state.billing_request_fulfilled: Authorises the billing request, and then fulfils
+ * it. The billing request must be in the pending state, with all actions completed
+ * except for bank_authorisation. Only billing requests with a
+ * payment_request are supported.billing_request_fulfilled_and_payment_failed: Authorises the billing
+ * request, fulfils it, and moves the associated payment to failed. The billing
+ * request must be in the pending state, with all actions completed except for
+ * bank_authorisation. Only billing requests with a payment_request
+ * are supported.billing_request_fulfilled_and_payment_confirmed_to_failed: Authorises the
+ * billing request, fulfils it, moves the associated payment to confirmed and then
+ * moves it to failed. The billing request must be in the pending
+ * state, with all actions completed except for bank_authorisation. Only billing
+ * requests with a payment_request are supported.billing_request_fulfilled_and_payment_paid_out: Authorises the billing
+ * request, fulfils it, and moves the associated payment to paid_out. The billing
+ * request must be in the pending state, with all actions completed except for
+ * bank_authorisation. Only billing requests with a payment_request
+ * are supported.active scheme identifiers will be
+ * applied to a creditor and used against payments.
*/
public Status getStatus() {
return status;
diff --git a/src/main/java/com/gocardless/resources/Subscription.java b/src/main/java/com/gocardless/resources/Subscription.java
index ada34d0d..026ef6bf 100644
--- a/src/main/java/com/gocardless/resources/Subscription.java
+++ b/src/main/java/com/gocardless/resources/Subscription.java
@@ -7,39 +7,48 @@
/**
* Represents a subscription resource returned from the API.
*
- * Subscriptions create [payments](#core-endpoints-payments) according to a schedule.
+ * Subscriptions create
+ * payments
+ * according to a schedule.
*
- * ### Recurrence Rules
+ * Recurrence Rules
The following rules apply when specifying recurrence:
*
- * The following rules apply when specifying recurrence:
- *
- * - If `day_of_month` and `start_date` are not provided `start_date` will be the
- * [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` and the subscription will then
- * recur based on the `interval` & `interval_unit` - If `month` or `day_of_month` are present the
- * following validations apply:
- *
- * | __interval_unit__ | __month__ | __day_of_month__ | | :---------------- |
- * :--------------------------------------------- | :----------------------------------------- | |
- * yearly | optional (required if `day_of_month` provided) | optional (invalid if `month` not
- * provided) | | monthly | invalid | optional | | weekly | invalid | invalid |
+ *
+ *
+ * | interval_unit | month | day_of_month | |
+ * :---------------- | :--------------------------------------------- |
+ * :----------------------------------------- | | yearly | optional (required if
+ * day_of_month and start_date are not provided
+ * start_date will be the
+ * 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
+ * apply:day_of_month provided) | optional (invalid if month not provided) | |
+ * monthly | invalid | optional | | weekly | invalid | invalid |
*
* Examples:
*
- * | __interval_unit__ | __interval__ | __month__ | __day_of_month__ | valid? | | :----------------
- * | :----------- | :-------- | :--------------- |
- * :------------------------------------------------- | | yearly | 1 | january | -1 | valid | |
- * monthly | 6 | | | valid | | monthly | 6 | | 12 | valid | | weekly | 2 | | | valid | | yearly | 1
- * | march | | invalid - missing `day_of_month` | | yearly | 1 | | 2 | invalid - missing `month` | |
- * monthly | 6 | august | 12 | invalid - `month` must be blank | | weekly | 2 | october | 10 |
- * invalid - `month` and `day_of_month` must be blank |
- *
- * ### Rolling dates
+ * | interval_unit | interval | month |
+ * day_of_month | valid? | | :---------------- | :----------- | :-------- |
+ * :--------------- | :------------------------------------------------- | | yearly | 1 | january |
+ * -1 | valid | | monthly | 6 | | | valid | | monthly | 6 | | 12 | valid | | weekly | 2 | | | valid
+ * | | yearly | 1 | march | | invalid - missing day_of_month | | yearly | 1 | | 2 |
+ * invalid - missing month | | monthly | 6 | august | 12 | invalid - month
+ * must be blank | | weekly | 2 | october | 10 | invalid - month and
+ * day_of_month must be blank |
*
- * When a charge date falls on a non-business day, one of two things will happen:
+ * Rolling dates
When a charge date falls on a non-business day, one of two things will
+ * happen:
*
- * - if the recurrence rule specified `-1` as the `day_of_month`, the charge date will be rolled
- * __backwards__ to the previous business day (i.e., the last working day of the month). - otherwise
- * the charge date will be rolled __forwards__ to the next business day.
+ *
+ *
*/
public class Subscription {
private Subscription() {
@@ -92,44 +101,52 @@ public Integer getCount() {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Fixed timestamp,
+ * recording when this resource was created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public String getCurrency() {
return currency;
}
/**
- * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or `-1` to indicate
- * the last day of the month.
+ * As per RFC 2445. The day of the month to charge customers on. -1 as the day_of_month, the charge
+ * date will be rolled backwards to the previous business day (i.e., the last
+ * working day of the month).1
+ *
+ *
+ *
+ * 28 or -1 to indicate the last day of the month.
*/
public Integer getDayOfMonth() {
return dayOfMonth;
}
/**
- * The earliest date that will be used as a `charge_date` on payments created for this
- * subscription if it is resumed. Only present for `paused` subscriptions. This value will
- * change over time.
+ * The earliest date that will be used as a charge_date on payments created for
+ * this subscription if it is resumed. Only present for paused subscriptions. This
+ * value will change over time.
*/
public String getEarliestChargeDateAfterResume() {
return earliestChargeDateAfterResume;
}
/**
- * Date on or after which no further payments should be created.
- * If this field is blank and `count` is not specified, the subscription will continue forever.
- *
+ * Date on or after which no further payments should be created.
+ *
+ * If this field is blank and count is not specified, the subscription will
+ * continue forever.
+ *
+ *
* count to specify a number of payments instead.
* interval_units between customer charge dates. Must be greater than or
+ * equal to 1. Must result in at least one charge date per year. Defaults to
+ * 1.
*/
public Integer getInterval() {
return interval;
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public IntervalUnit getIntervalUnit() {
return intervalUnit;
@@ -172,8 +191,7 @@ public Mapyearly.
*/
public Month getMonth() {
return month;
@@ -196,8 +214,11 @@ 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 payment
- * endpoint](#payments-create-a-payment) for more details.
+ * will appear on your customer's bank statement. See the documentation for the
+ * create
+ * payment endpoint for more details.
+ *
+ *
* 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
+ * mandate's next_possible_charge_date
*/
public String getStartDate() {
return startDate;
@@ -232,15 +255,18 @@ public String getStartDate() {
/**
* One of:
+ *
*
- *
*/
public Status getStatus() {
@@ -303,8 +329,9 @@ private Links() {
private String mandate;
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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 e8eca81a..bcc42683 100644
--- a/src/main/java/com/gocardless/resources/TaxRate.java
+++ b/src/main/java/com/gocardless/resources/TaxRate.java
@@ -5,7 +5,9 @@
*
* Tax rates from tax authority.
*
- * We also maintain a [static list of the tax rates for each jurisdiction](#appendix-tax-rates).
+ * 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 26219732..ceb170b7 100644
--- a/src/main/java/com/gocardless/resources/TransferredMandate.java
+++ b/src/main/java/com/gocardless/resources/TransferredMandate.java
@@ -16,8 +16,9 @@ private TransferredMandate() {
private String publicKeyId;
/**
- * Encrypted customer bank account details, containing: `iban`, `account_holder_name`,
- * `swift_bank_code`, `swift_branch_code`, `swift_account_number`
+ * Encrypted customer bank account details, containing: pending_customer_approval: the subscription is waiting for customer approval
+ * before becoming activecustomer_approval_denied: the customer did not approve the subscriptionactive: the subscription is currently active and will continue to create
+ * paymentsfinished: all of the payments scheduled for creation under this subscription
+ * have been createdcancelled: the subscription has been cancelled and will no longer create
+ * paymentspaused: the subscription has been paused and will not create paymentsiban,
+ * account_holder_name, swift_bank_code,
+ * swift_branch_code, swift_account_number
*/
public String getEncryptedCustomerBankDetails() {
return encryptedCustomerBankDetails;
@@ -56,7 +57,8 @@ private Links() {
private String mandate;
/**
- * The ID of the updated [customer_bank_account](#core-endpoints-customer-bank-accounts)
+ * The ID of the updated 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 d0538d52..0d6ab436 100644
--- a/src/main/java/com/gocardless/resources/VerificationDetail.java
+++ b/src/main/java/com/gocardless/resources/VerificationDetail.java
@@ -9,8 +9,9 @@
*
* extends ListRequest withBefore(String before) {
}
/**
- * ID of a [creditor](#core-endpoints-creditors).
+ * 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 068075ae..ae896368 100644
--- a/src/main/java/com/gocardless/services/BankAccountDetailService.java
+++ b/src/main/java/com/gocardless/services/BankAccountDetailService.java
@@ -26,9 +26,9 @@ public BankAccountDetailService(HttpClient httpClient) {
* Returns bank account details in the flattened JSON Web Encryption format described in RFC
* 7516.
*
- * You must specify a `Gc-Key-Id` header when using this endpoint. See [Public Key
- * Setup](https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup) for
- * more details.
+ * You must specify a Gc-Key-Id header when using this endpoint. See Public Key
+ * Setup for more details.
*/
public BankAccountDetailGetRequest get(String identity) {
return new BankAccountDetailGetRequest(httpClient, identity);
@@ -40,9 +40,9 @@ public BankAccountDetailGetRequest get(String identity) {
* Returns bank account details in the flattened JSON Web Encryption format described in RFC
* 7516.
*
- * You must specify a `Gc-Key-Id` header when using this endpoint. See [Public Key
- * Setup](https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup) for
- * more details.
+ * You must specify a Gc-Key-Id header when using this endpoint. See Public Key
+ * Setup for more details.
*/
public static final class BankAccountDetailGetRequest extends GetRequestoutcome=success or outcome=failure will be appended to the
+ * redirect_uri to indicate the result of the bank authorisation. If the bank
+ * authorisation is expired, the query parameter outcome=timeout will be
+ * appended to the redirect_uri, in which case you should prompt the user to
+ * try the bank authorisation step again.
*
- * 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`](#billing-request-bankauthorisationauthorised),
- * [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or
- * [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in order to show
- * the correct outcome to the user.
+ * 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,
+ * BANK_AUTHORISATION_DENIED,
+ * or 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 parameter
- * `id=BRF123`.
+ * The BillingRequestFlow ID will also be appended to the redirect_uri as query
+ * parameter id=BRF123.
*
- * Defaults to `https://pay.gocardless.com/billing/static/thankyou`.
+ * Defaults to https://pay.gocardless.com/billing/static/thankyou.
*/
public BankAuthorisationCreateRequest withRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
@@ -141,8 +145,9 @@ public static class Links {
private String billingRequest;
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this
- * authorisation was created.
+ * ID of the billing
+ * request against which this authorisation was created.
*/
public Links withBillingRequest(String billingRequest) {
this.billingRequest = billingRequest;
diff --git a/src/main/java/com/gocardless/services/BankDetailsLookupService.java b/src/main/java/com/gocardless/services/BankDetailsLookupService.java
index 7e86c1da..f2664a58 100644
--- a/src/main/java/com/gocardless/services/BankDetailsLookupService.java
+++ b/src/main/java/com/gocardless/services/BankDetailsLookupService.java
@@ -28,21 +28,23 @@ public BankDetailsLookupService(HttpClient httpClient) {
* a sort code or an iban are already present), we verify that the account holder name and bank
* account number match the details held by the relevant bank.
*
- * If your request returns an [error](#api-usage-errors) 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.
+ * If your request returns an
+ * 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](#appendix-local-bank-details) or
- * an IBAN.
+ * Bank account details may be supplied using
+ * 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 bank account
- * is discovered to be closed or invalid, the customer is requested to adjust the account
- * number/routing number and succeed in this check to continue with the flow.
+ * 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
+ * bank account is discovered to be closed or invalid, the customer is requested to adjust the
+ * account number/routing number and succeed in this check to continue with the flow.
*
- * _Note:_ Usage of this endpoint is monitored. If your organisation relies on GoCardless for
- * modulus or reachability checking but not for payment collection, please get in touch.
+ * Note: Usage of this endpoint is monitored. If your organisation relies on GoCardless
+ * for modulus or reachability checking but not for payment collection, please get in touch.
*/
public BankDetailsLookupCreateRequest create() {
return new BankDetailsLookupCreateRequest(httpClient);
@@ -58,21 +60,23 @@ public BankDetailsLookupCreateRequest create() {
* a sort code or an iban are already present), we verify that the account holder name and bank
* account number match the details held by the relevant bank.
*
- * If your request returns an [error](#api-usage-errors) 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.
+ * If your request returns an
+ * 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](#appendix-local-bank-details) or
- * an IBAN.
+ * Bank account details may be supplied using
+ * 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 bank account
- * is discovered to be closed or invalid, the customer is requested to adjust the account
- * number/routing number and succeed in this check to continue with the flow.
+ * 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
+ * bank account is discovered to be closed or invalid, the customer is requested to adjust the
+ * account number/routing number and succeed in this check to continue with the flow.
*
- * _Note:_ Usage of this endpoint is monitored. If your organisation relies on GoCardless for
- * modulus or reachability checking but not for payment collection, please get in touch.
+ * Note: Usage of this endpoint is monitored. If your organisation relies on GoCardless
+ * for modulus or reachability checking but not for payment collection, please get in touch.
*/
public static final class BankDetailsLookupCreateRequest
extends PostRequestiban.
*/
public BankDetailsLookupCreateRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -102,8 +107,9 @@ public BankDetailsLookupCreateRequest withAccountNumber(String accountNumber) {
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BankDetailsLookupCreateRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -111,8 +117,9 @@ public BankDetailsLookupCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BankDetailsLookupCreateRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -120,9 +127,9 @@ public BankDetailsLookupCreateRequest withBranchCode(String branchCode) {
}
/**
- * [ISO
- * 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
- * alpha-2 code. Must be provided if specifying local details.
+ * ISO
+ * 3166-1 alpha-2 code. Must be provided if specifying local details.
*/
public BankDetailsLookupCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -130,8 +137,9 @@ public BankDetailsLookupCreateRequest withCountryCode(String countryCode) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details).
+ * International Bank Account Number. Alternatively you can provide local
+ * details.
*/
public BankDetailsLookupCreateRequest withIban(String iban) {
this.iban = iban;
diff --git a/src/main/java/com/gocardless/services/BillingRequestFlowService.java b/src/main/java/com/gocardless/services/BillingRequestFlowService.java
index 8c0dd055..df6022ab 100644
--- a/src/main/java/com/gocardless/services/BillingRequestFlowService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestFlowService.java
@@ -90,8 +90,8 @@ public BillingRequestFlowCreateRequest withExitUri(String exitUri) {
}
/**
- * Sets the default language of the Billing Request Flow and the customer. [ISO
- * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code.
+ * Sets the default language of the Billing Request Flow and the customer.
+ * ISO 639-1 code.
*/
public BillingRequestFlowCreateRequest withLanguage(String language) {
this.language = language;
@@ -104,8 +104,9 @@ public BillingRequestFlowCreateRequest withLinks(Links links) {
}
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this flow
- * was created.
+ * ID of the billing
+ * request against which this flow was created.
*/
public BillingRequestFlowCreateRequest withLinksBillingRequest(String billingRequest) {
if (links == null) {
@@ -122,7 +123,6 @@ public BillingRequestFlowCreateRequest withLinksBillingRequest(String billingReq
*
* You can only lock bank account if these have already been completed as a part of the
* billing request.
- *
*/
public BillingRequestFlowCreateRequest withLockBankAccount(Boolean lockBankAccount) {
this.lockBankAccount = lockBankAccount;
@@ -146,7 +146,6 @@ public BillingRequestFlowCreateRequest withLockCurrency(Boolean lockCurrency) {
*
* You can only lock customer details if these have already been completed as a part of the
* billing request.
- *
*/
public BillingRequestFlowCreateRequest withLockCustomerDetails(
Boolean lockCustomerDetails) {
@@ -167,8 +166,9 @@ public BillingRequestFlowCreateRequest withPrefilledBankAccount(
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
- * accounts in other currencies. See [local details](#local-bank-details-united-states) for
- * more information.
+ * accounts in other currencies. See local
+ * details for more information.
*/
public BillingRequestFlowCreateRequest withPrefilledBankAccountAccountType(
PrefilledBankAccount.AccountType accountType) {
@@ -238,8 +238,8 @@ public BillingRequestFlowCreateRequest withPrefilledCustomerCity(String city) {
}
/**
- * Customer's company name. Company name should only be provided if `given_name` and
- * `family_name` are null.
+ * Customer's company name. Company name should only be provided if given_name
+ * and family_name are null.
*/
public BillingRequestFlowCreateRequest withPrefilledCustomerCompanyName(
String companyName) {
@@ -251,8 +251,9 @@ public BillingRequestFlowCreateRequest withPrefilledCustomerCompanyName(
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public BillingRequestFlowCreateRequest withPrefilledCustomerCountryCode(
String countryCode) {
@@ -418,8 +419,9 @@ public static class Links {
private String billingRequest;
/**
- * ID of the [billing request](#billing-requests-billing-requests) against which this
- * flow was created.
+ * ID of the billing
+ * request against which this flow was created.
*/
public Links withBillingRequest(String billingRequest) {
this.billingRequest = billingRequest;
@@ -432,8 +434,9 @@ public static class PrefilledBankAccount {
/**
* Bank account type for USD-denominated bank accounts. Must not be provided for bank
- * accounts in other currencies. See [local details](#local-bank-details-united-states)
- * for more information.
+ * accounts in other currencies. See local
+ * details for more information.
*/
public PrefilledBankAccount withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -501,8 +504,8 @@ public PrefilledCustomer withCity(String city) {
}
/**
- * Customer's company name. Company name should only be provided if `given_name` and
- * `family_name` are null.
+ * Customer's company name. Company name should only be provided if
+ * given_name and family_name are null.
*/
public PrefilledCustomer withCompanyName(String companyName) {
this.companyName = companyName;
@@ -510,8 +513,9 @@ public PrefilledCustomer withCompanyName(String companyName) {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public PrefilledCustomer withCountryCode(String countryCode) {
this.countryCode = countryCode;
diff --git a/src/main/java/com/gocardless/services/BillingRequestService.java b/src/main/java/com/gocardless/services/BillingRequestService.java
index c3ae4839..c7617a42 100644
--- a/src/main/java/com/gocardless/services/BillingRequestService.java
+++ b/src/main/java/com/gocardless/services/BillingRequestService.java
@@ -16,12 +16,11 @@
* 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 Requests:
- * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) for
- * how-to's, explanations and tutorials.
+ * See Billing
+ * Requests: Overview for how-to's, explanations and tutorials.
* subscription_request and
+ * instalment_schedule_request are only supported for ACH and PAD schemes.
* subscription_request
+ * and instalment_schedule_request are only supported for ACH and PAD schemes.
* subscription_request
+ * and instalment_schedule_request are only supported for ACH and PAD schemes.
* amount
+ * and charge_date. See create
+ * (with dates)
*/
public BillingRequestCreateRequest withInstalmentScheduleRequestInstalmentsWithDates(
List
+ * and will appear on your customer's bank statement. See the documentation for the create
+ * payment endpoint for more details.
+ *
*/
public BillingRequestCreateRequest withInstalmentScheduleRequestPaymentReference(
String paymentReference) {
@@ -294,11 +299,12 @@ public BillingRequestCreateRequest withInstalmentScheduleRequestPaymentReference
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). Default is `false`.
+ * On failure, automatically retry payments using
+ * intelligent retries.
+ * Default is false.
* one_off, recurring or standing for ACH
+ * scheme. And single, recurring and sporadic for PAD
+ * scheme. Note: This is only supported for ACH and PAD schemes.
*/
public BillingRequestCreateRequest withMandateRequestConsentType(String consentType) {
if (mandateRequest == null) {
@@ -419,7 +426,7 @@ public BillingRequestCreateRequest withMandateRequestConstraints(Constraints con
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+ * ISO 4217 currency code.
*/
public BillingRequestCreateRequest withMandateRequestCurrency(String currency) {
if (mandateRequest == null) {
@@ -432,7 +439,6 @@ public BillingRequestCreateRequest withMandateRequestCurrency(String currency) {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public BillingRequestCreateRequest withMandateRequestDescription(String description) {
if (mandateRequest == null) {
@@ -445,10 +451,12 @@ public BillingRequestCreateRequest withMandateRequestDescription(String descript
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct`
- * will be a direct transfer from the payer's account to the merchant where invoicing will
- * be handled separately.
- *
+ *
+ *
*/
public BillingRequestCreateRequest withMandateRequestFundsSettlement(
MandateRequest.FundsSettlement fundsSettlement) {
@@ -473,9 +481,10 @@ public BillingRequestCreateRequest withMandateRequestMetadata(
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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) {
@@ -514,26 +523,29 @@ public BillingRequestCreateRequest withMandateRequestSweeping(Boolean sweeping)
/**
* Verification preference for the mandate. One of:
+ *
* managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It uses
- * GoCardless payment intelligence solution to determine if a payer is fraudulent or not.
- * The verification mechanism is based on the response and the payer may be asked to verify
- * themselves. If the feature is not available, `recommended` behaves like `minimum`.
+ * By default, all Billing Requests use the minimum: only verify if absolutely required, such as when part of scheme
+ * rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use themalways: as when_available, but fail to create the Billing
+ * Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer is
+ * fraudulent or not. The verification mechanism is based on the response and the payer may
+ * be asked to verify themselves. If the feature is not available, recommended
+ * behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified Mandates as
- * they are released in new schemes, please use the `minimum` verification preference.
+ * they are released in new schemes, please use the minimum verification
+ * preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public BillingRequestCreateRequest withMandateRequestVerify(MandateRequest.Verify verify) {
if (mandateRequest == null) {
@@ -579,9 +591,9 @@ 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 Commercial Payment Purpose
- * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for the
- * complete list of valid codes.
+ * compliance. See
+ * VRP
+ * Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public BillingRequestCreateRequest withPaymentPurposeCode(String paymentPurposeCode) {
this.paymentPurposeCode = paymentPurposeCode;
@@ -618,9 +630,9 @@ public BillingRequestCreateRequest withPaymentRequestAppFee(Integer appFee) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and
- * `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in
- * supported Eurozone countries only.
+ * ISO 4217 currency code.
+ * GBP and EUR supported; GBP with your customers in
+ * the UK and for EUR with your customers in supported Eurozone countries only.
*/
public BillingRequestCreateRequest withPaymentRequestCurrency(String currency) {
if (paymentRequest == null) {
@@ -633,7 +645,6 @@ public BillingRequestCreateRequest withPaymentRequestCurrency(String currency) {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public BillingRequestCreateRequest withPaymentRequestDescription(String description) {
if (paymentRequest == null) {
@@ -646,10 +657,12 @@ public BillingRequestCreateRequest withPaymentRequestDescription(String descript
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct`
- * will be a direct transfer from the payer's account to the merchant where invoicing will
- * be handled separately.
- *
+ *
+ *
*/
public BillingRequestCreateRequest withPaymentRequestFundsSettlement(
PaymentRequest.FundsSettlement fundsSettlement) {
@@ -677,7 +690,6 @@ public BillingRequestCreateRequest withPaymentRequestMetadata(
* A custom payment reference defined by the merchant. It is only available for payments on
* the PayTo scheme or payments using the Direct Funds settlement model on the Faster
* Payments scheme.
- *
*/
public BillingRequestCreateRequest withPaymentRequestReference(String reference) {
if (paymentRequest == null) {
@@ -688,11 +700,12 @@ public BillingRequestCreateRequest withPaymentRequestReference(String reference)
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). Default is `false`.
+ * On failure, automatically retry payments using
+ * intelligent retries.
+ * Default is managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.false.
* faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public BillingRequestCreateRequest withPaymentRequestScheme(String scheme) {
if (paymentRequest == null) {
@@ -725,9 +739,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](https://developer.gocardless.com/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;
@@ -776,8 +790,8 @@ public BillingRequestCreateRequest withSubscriptionRequestCount(Integer count) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public BillingRequestCreateRequest withSubscriptionRequestCurrency(String currency) {
if (subscriptionRequest == null) {
@@ -788,8 +802,11 @@ public BillingRequestCreateRequest withSubscriptionRequestCurrency(String curren
}
/**
- * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or `-1` to
- * indicate the last day of the month.
+ * As per RFC 2445. The day of the month to charge customers on. 1
+ *
+ *
+ *
+ * 28 or -1 to indicate the last day of the month.
*/
public BillingRequestCreateRequest withSubscriptionRequestDayOfMonth(Integer dayOfMonth) {
if (subscriptionRequest == null) {
@@ -800,8 +817,9 @@ public BillingRequestCreateRequest withSubscriptionRequestDayOfMonth(Integer day
}
/**
- * Number of `interval_units` between customer charge dates. Must be greater than or equal
- * to `1`. Must result in at least one charge date per year. Defaults to `1`.
+ * Number of interval_units between customer charge dates. Must be greater than
+ * or equal to 1. Must result in at least one charge date per year. Defaults to
+ * 1.
*/
public BillingRequestCreateRequest withSubscriptionRequestInterval(Integer interval) {
if (subscriptionRequest == null) {
@@ -812,7 +830,8 @@ public BillingRequestCreateRequest withSubscriptionRequestInterval(Integer inter
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public BillingRequestCreateRequest withSubscriptionRequestIntervalUnit(
SubscriptionRequest.IntervalUnit intervalUnit) {
@@ -838,8 +857,7 @@ public BillingRequestCreateRequest withSubscriptionRequestMetadata(
/**
* Name of the month on which to charge a customer. Must be lowercase. Only applies when the
- * interval_unit is `yearly`.
- *
+ * interval_unit is yearly.
*/
public BillingRequestCreateRequest withSubscriptionRequestMonth(
SubscriptionRequest.Month month) {
@@ -864,8 +882,10 @@ 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
- * payment endpoint](#payments-create-a-payment) for more details.
+ * and will appear on your customer's bank statement. See the documentation for the create
+ * payment endpoint for more details.
+ *
*/
public BillingRequestCreateRequest withSubscriptionRequestPaymentReference(
String paymentReference) {
@@ -877,11 +897,12 @@ public BillingRequestCreateRequest withSubscriptionRequestPaymentReference(
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). 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 mandate's
+ * next_possible_charge_date.
*/
public BillingRequestCreateRequest withSubscriptionRequestStartDate(String startDate) {
if (subscriptionRequest == null) {
@@ -1041,6 +1062,14 @@ public static class InstalmentsWithDates {
/**
* Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in
* EUR).
+ *
+ * Minimum and maximum amounts vary by payment scheme. For more information, see
+ * Transaction
+ * limits
+ *
+ * For Variable Recurring Payments (VRP), this must not exceed the mandate's
+ * max_amount_per_payment constraint.
*/
public InstalmentsWithDates withAmount(Integer amount) {
this.amount = amount;
@@ -1049,8 +1078,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](#core-endpoints-mandates), 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;
@@ -1060,8 +1090,9 @@ 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
- * requirements](#appendix-compliance-requirements)).
+ * send its own notifications (see compliance
+ * requirements).
*/
public InstalmentsWithDates withDescription(String description) {
this.description = description;
@@ -1092,7 +1123,6 @@ public static class InstalmentsWithSchedule {
/**
* List of amounts of each instalment, in the lowest denomination for the currency (e.g.
* cents in USD).
- *
*/
public InstalmentsWithSchedule withAmounts(Listinterval_units between charge dates. Must be greater than or
+ * equal to 1.
*/
public InstalmentsWithSchedule withInterval(Integer interval) {
this.interval = interval;
@@ -1110,8 +1139,8 @@ public InstalmentsWithSchedule withInterval(Integer interval) {
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public InstalmentsWithSchedule withIntervalUnit(IntervalUnit intervalUnit) {
this.intervalUnit = intervalUnit;
@@ -1120,10 +1149,12 @@ public InstalmentsWithSchedule withIntervalUnit(IntervalUnit intervalUnit) {
/**
* The date on which the first payment should be charged. Must be on or after the
- * [mandate](#core-endpoints-mandates)'s `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
- * mandate's `next_possible_charge_date`
+ * mandate's
+ * 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 mandate's next_possible_charge_date
*/
public InstalmentsWithSchedule withStartDate(String startDate) {
this.startDate = startDate;
@@ -1183,8 +1214,8 @@ public InstalmentScheduleRequest withAppFee(Integer appFee) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "USD" and "CAD" are supported.
+ * ISO 4217 currency
+ * code. Currently "USD" and "CAD" are supported.
*/
public InstalmentScheduleRequest withCurrency(String currency) {
this.currency = currency;
@@ -1192,8 +1223,10 @@ public InstalmentScheduleRequest withCurrency(String currency) {
}
/**
- * An explicit array of instalment payments, each specifying at least an `amount` and
- * `charge_date`. See [create (with dates)](#instalment-schedules-create-with-dates)
+ * An explicit array of instalment payments, each specifying at least an
+ * amount and charge_date. See create
+ * (with dates)
*/
public InstalmentScheduleRequest withInstalmentsWithDates(
List
+ * the create
+ * payment endpoint for more details.
+ *
*/
public InstalmentScheduleRequest withPaymentReference(String paymentReference) {
this.paymentReference = paymentReference;
@@ -1242,11 +1279,13 @@ public InstalmentScheduleRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). Default is `false`.
+ * On failure, automatically retry payments using
+ * intelligent
+ * retries. Default is false.
* creation_date if not specified.
*
- * `calendar` - this will finish on the end of the current period. For example this will
- * expire on the Monday for the current week or the January for the next year.
+ * calendar
+ *
+ *
+ * week runs Monday to Sunday, month runs from the 1st to the
+ * last day of the calendar month, and year runs from 1 January to 31
+ * December. If the mandate starts partway through a period, the limit for that first
+ * period is reduced proportionally to the days remaining (e.g. a monthly limit starting
+ * on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period. For
- * example Monthly it will expire on the same day of the next month, or yearly the same
- * day of the next year.
+ * creation_date
+ *
+ *
*
+ * Note: Has no effect when period is flexible.
*/
public PeriodicLimits withAlignment(Alignment alignment) {
this.alignment = alignment;
@@ -1323,9 +1376,9 @@ public PeriodicLimits withAlignment(Alignment alignment) {
}
/**
- * The maximum number of payments that can be collected in this periodic limit. _Note:_
- * This is only supported for the PayTo scheme, where it is required.
+ * The maximum number of payments that can be collected in this periodic limit.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public PeriodicLimits withMaxPayments(Integer maxPayments) {
this.maxPayments = maxPayments;
@@ -1333,9 +1386,10 @@ public PeriodicLimits withMaxPayments(Integer maxPayments) {
}
/**
- * The maximum total amount that can be charged for all payments in this periodic limit.
- * Required for VRP.
+ * The maximum total amount that can be charged for all payments in this periodic limit,
+ * in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
this.maxTotalAmount = maxTotalAmount;
@@ -1343,8 +1397,9 @@ public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is provided
+ * (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this
+ * defaults to flexible.
*/
public PeriodicLimits withPeriod(Period period) {
this.period = period;
@@ -1410,7 +1465,6 @@ public static class Constraints {
* This is an optional field and if it is not supplied the agreement will be considered
* open and will not have an end date. Keep in mind the end date must take into account
* how long it will take the user to set up this agreement via the Billing Request.
- *
*/
public Constraints withEndDate(String endDate) {
this.endDate = endDate;
@@ -1418,8 +1472,9 @@ public Constraints withEndDate(String endDate) {
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and
- * VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public Constraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
this.maxAmountPerPayment = maxAmountPerPayment;
@@ -1428,8 +1483,8 @@ public Constraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public Constraints withPaymentMethod(String paymentMethod) {
this.paymentMethod = paymentMethod;
@@ -1437,7 +1492,12 @@ public Constraints withPaymentMethod(String paymentMethod) {
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public Constraints withPeriodicLimits(Listone_off, recurring or standing
+ * for ACH scheme. And single, recurring and
+ * sporadic for PAD scheme. Note: This is only supported for ACH
+ * and PAD schemes.
*/
public MandateRequest withConsentType(String consentType) {
this.consentType = consentType;
@@ -1528,7 +1586,8 @@ public MandateRequest withConstraints(Constraints constraints) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+ * ISO 4217 currency
+ * code.
*/
public MandateRequest withCurrency(String currency) {
this.currency = currency;
@@ -1538,7 +1597,6 @@ public MandateRequest withCurrency(String currency) {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to
* the payer when authorising the billing request.
- *
*/
public MandateRequest withDescription(String description) {
this.description = description;
@@ -1548,10 +1606,12 @@ public MandateRequest withDescription(String description) {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. -
- * `direct` will be a direct transfer from the payer's account to the merchant where
- * invoicing will be handled separately.
- *
+ *
+ *
*/
public MandateRequest withFundsSettlement(FundsSettlement fundsSettlement) {
this.fundsSettlement = fundsSettlement;
@@ -1568,9 +1628,10 @@ public MandateRequest withMetadata(Mapmanaged will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It
- * uses GoCardless payment intelligence solution to determine if a payer is fraudulent
- * or not. The verification mechanism is based on the response and the payer may be
- * asked to verify themselves. If the feature is not available, `recommended` behaves
- * like `minimum`.
+ * By default, all Billing Requests use the minimum: only verify if absolutely required, such as when part of
+ * scheme rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use
+ * themalways: as when_available, but fail to create the
+ * Billing Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer
+ * is fraudulent or not. The verification mechanism is based on the response and the
+ * payer may be asked to verify themselves. If the feature is not available,
+ * recommended behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified
- * Mandates as they are released in new schemes, please use the `minimum` verification
- * preference.
+ * Mandates as they are released in new schemes, please use the minimum
+ * verification preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public MandateRequest withVerify(Verify verify) {
this.verify = verify;
@@ -1699,9 +1761,10 @@ public PaymentRequest withAppFee(Integer appFee) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP`
- * and `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your
- * customers in supported Eurozone countries only.
+ * ISO 4217 currency
+ * code. GBP and EUR supported; GBP with your
+ * customers in the UK and for EUR with your customers in supported
+ * Eurozone countries only.
*/
public PaymentRequest withCurrency(String currency) {
this.currency = currency;
@@ -1711,7 +1774,6 @@ public PaymentRequest withCurrency(String currency) {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to
* the payer when authorising the billing request.
- *
*/
public PaymentRequest withDescription(String description) {
this.description = description;
@@ -1721,10 +1783,12 @@ public PaymentRequest withDescription(String description) {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. -
- * `direct` will be a direct transfer from the payer's account to the merchant where
- * invoicing will be handled separately.
- *
+ *
+ *
*/
public PaymentRequest withFundsSettlement(FundsSettlement fundsSettlement) {
this.fundsSettlement = fundsSettlement;
@@ -1744,7 +1808,6 @@ public PaymentRequest withMetadata(Mapmanaged will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.false.
* faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your
* customer.
*/
public PaymentRequest withScheme(String scheme) {
@@ -1835,8 +1901,9 @@ public SubscriptionRequest withCount(Integer count) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency
+ * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
+ * supported.
*/
public SubscriptionRequest withCurrency(String currency) {
this.currency = currency;
@@ -1844,8 +1911,11 @@ public SubscriptionRequest withCurrency(String currency) {
}
/**
- * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or `-1` to
- * indicate the last day of the month.
+ * As per RFC 2445. The day of the month to charge customers on. 1
+ *
+ *
+ *
+ * 28 or -1 to indicate the last day of the month.
*/
public SubscriptionRequest withDayOfMonth(Integer dayOfMonth) {
this.dayOfMonth = dayOfMonth;
@@ -1853,8 +1923,9 @@ public SubscriptionRequest withDayOfMonth(Integer dayOfMonth) {
}
/**
- * Number of `interval_units` between customer charge dates. Must be greater than or
- * equal to `1`. Must result in at least one charge date per year. Defaults to `1`.
+ * Number of interval_units between customer charge dates. Must be greater
+ * than or equal to 1. Must result in at least one charge date per year.
+ * Defaults to 1.
*/
public SubscriptionRequest withInterval(Integer interval) {
this.interval = interval;
@@ -1862,8 +1933,8 @@ public SubscriptionRequest withInterval(Integer interval) {
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public SubscriptionRequest withIntervalUnit(IntervalUnit intervalUnit) {
this.intervalUnit = intervalUnit;
@@ -1881,8 +1952,7 @@ public SubscriptionRequest withMetadata(Mapyearly.
*/
public SubscriptionRequest withMonth(Month month) {
this.month = month;
@@ -1901,7 +1971,10 @@ 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 payment endpoint](#payments-create-a-payment) for more details.
+ * the create
+ * payment endpoint for more details.
+ *
*/
public SubscriptionRequest withPaymentReference(String paymentReference) {
this.paymentReference = paymentReference;
@@ -1909,11 +1982,13 @@ public SubscriptionRequest withPaymentReference(String paymentReference) {
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). 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 mandate's
+ * next_possible_charge_date.
*/
public SubscriptionRequest withStartDate(String startDate) {
this.startDate = startDate;
@@ -1996,10 +2071,11 @@ public BillingRequestCollectCustomerDetailsRequest withCustomer(Customer custome
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are provided.
- * For Canadian customers, the use of a `company_name` value will mean that any mandate
- * created from this customer will be considered to be a "Business PAD" (otherwise, any
- * mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered to
+ * be a "Personal PAD").
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerCompanyName(
String companyName) {
@@ -2023,7 +2099,7 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerEmail(String emai
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerFamilyName(
String familyName) {
@@ -2035,7 +2111,7 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerFamilyName(
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerGivenName(String givenName) {
if (customer == null) {
@@ -2046,12 +2122,14 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerGivenName(String
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not send
- * its own (see [compliance requirements](#appendix-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 language is default to "en".
+ * ISO 639-1 code. Used
+ * as the language for notification emails sent by GoCardless if your organisation does not
+ * send 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 and a customer was linked during
+ * billing request creation, the linked customer language will be used. Otherwise, the
+ * language is default to "en".
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerLanguage(String language) {
if (customer == null) {
@@ -2075,8 +2153,8 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerMetadata(
}
/**
- * [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, including
- * country code.
+ * ITU E.123 formatted phone number,
+ * including country code.
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerPhoneNumber(
String phoneNumber) {
@@ -2142,8 +2220,9 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailCity
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailCountryCode(
String countryCode) {
@@ -2172,9 +2251,8 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailDani
* the payer to whom the mandate belongs (i.e. as a result of their completion of a mandate
* setup flow in their browser).
*
- * Not required for creating offline mandates where `authorisation_source` is set to
- * telephone or paper.
- *
+ * Not required for creating offline mandates where authorisation_source is set
+ * to telephone or paper.
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailIpAddress(
String ipAddress) {
@@ -2199,8 +2277,8 @@ public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailPost
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public BillingRequestCollectCustomerDetailsRequest withCustomerBillingDetailRegion(
String region) {
@@ -2279,10 +2357,11 @@ public static class Customer {
private String phoneNumber;
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are
- * provided. For Canadian customers, the use of a `company_name` value will mean that
- * any mandate created from this customer will be considered to be a "Business PAD"
- * (otherwise, any mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered
+ * to be a "Personal PAD").
*/
public Customer withCompanyName(String companyName) {
this.companyName = companyName;
@@ -2299,7 +2378,7 @@ public Customer withEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public Customer withFamilyName(String familyName) {
this.familyName = familyName;
@@ -2307,7 +2386,7 @@ public Customer withFamilyName(String familyName) {
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public Customer withGivenName(String givenName) {
this.givenName = givenName;
@@ -2315,13 +2394,14 @@ public Customer withGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not
- * send its own (see [compliance requirements](#appendix-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 language is
- * default to "en".
+ * ISO 639-1 code.
+ * Used as the language for notification emails sent by GoCardless if your organisation
+ * does not send 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 and a customer was linked
+ * during billing request creation, the linked customer language will be used.
+ * Otherwise, the language is default to "en".
*/
public Customer withLanguage(String language) {
this.language = language;
@@ -2338,8 +2418,8 @@ public Customer withMetadata(Mapauthorisation_source is
+ * set to telephone or paper.
*/
public CustomerBillingDetail withIpAddress(String ipAddress) {
this.ipAddress = ipAddress;
@@ -2433,8 +2513,8 @@ public CustomerBillingDetail withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required
- * (e.g. `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public CustomerBillingDetail withRegion(String region) {
this.region = region;
@@ -2466,15 +2546,15 @@ public CustomerBillingDetail withSwedishIdentityNumber(String swedishIdentityNum
* If the scheme is PayTo and the pay_id is available, this can be included in the payload along
* with the country_code.
*
- * _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 bank account
- * is discovered to be closed or invalid, the customer is requested to adjust the account
- * number/routing number and succeed in this check to continue with the flow.
+ * 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
+ * bank account is discovered to be closed or invalid, the customer is requested to adjust the
+ * account number/routing number and succeed in this check to continue with the flow.
*
- * _BACS scheme_ [Payer Name
- * Verification](https://hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB)
- * is enabled by default for UK based bank accounts, meaning we verify the account holder name
- * and bank account number match the details held by the relevant bank.
+ * BACS scheme Payer
+ * Name Verification is enabled by default for UK based bank accounts, meaning we verify the
+ * account holder name and bank account number match the details held by the relevant bank.
*/
public static final class BillingRequestCollectBankAccountRequest
extends PostRequestiban.
*/
public BillingRequestCollectBankAccountRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -2515,8 +2597,9 @@ public BillingRequestCollectBankAccountRequest withAccountNumber(String accountN
}
/**
- * Account number suffix (only for bank accounts denominated in NZD) - see [local
- * details](#local-bank-details-new-zealand) for more information.
+ * Account number suffix (only for bank accounts denominated in NZD) - see local
+ * details for more information.
*/
public BillingRequestCollectBankAccountRequest withAccountNumberSuffix(
String accountNumberSuffix) {
@@ -2526,8 +2609,9 @@ public BillingRequestCollectBankAccountRequest withAccountNumberSuffix(
/**
* Bank account type. Required for USD-denominated bank accounts. Must not be provided for
- * bank accounts in other currencies. See [local details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public BillingRequestCollectBankAccountRequest withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -2535,8 +2619,9 @@ public BillingRequestCollectBankAccountRequest withAccountType(AccountType accou
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BillingRequestCollectBankAccountRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -2544,8 +2629,9 @@ public BillingRequestCollectBankAccountRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BillingRequestCollectBankAccountRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -2553,9 +2639,10 @@ public BillingRequestCollectBankAccountRequest withBranchCode(String branchCode)
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public BillingRequestCollectBankAccountRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -2563,8 +2650,8 @@ public BillingRequestCollectBankAccountRequest withCountryCode(String countryCod
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public BillingRequestCollectBankAccountRequest withCurrency(String currency) {
this.currency = currency;
@@ -2572,9 +2659,12 @@ public BillingRequestCollectBankAccountRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
- * denominated in SEK - you must supply [local details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public BillingRequestCollectBankAccountRequest withIban(String iban) {
this.iban = iban;
@@ -2910,10 +3000,11 @@ protected String getRequestEnvelope() {
/**
* Request class for {@link BillingRequestService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your billing requests.
+ * Returns a cursor-paginated
+ * list of your billing requests.
*/
public static final class BillingRequestListRequest extends ListRequest withBefore(String before) {
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
- */
- public BillingRequestListRequest withCreatedAt(String createdAt) {
- this.createdAt = createdAt;
- return this;
- }
-
- /**
- * ID of a [customer](#core-endpoints-customers). If specified, this endpoint will return
- * all requests for the given customer.
+ * ID of a customer.
+ * If specified, this endpoint will return all requests for the given customer.
*/
public BillingRequestListRequest withCustomer(String customer) {
this.customer = customer;
@@ -2960,12 +3044,15 @@ public BillingRequestListRequest withLimit(Integer limit) {
/**
* One of:
+ *
*
- *
*/
public BillingRequestListRequestpending: the billing request is pending and can be usedready_to_fulfil: the billing request is ready to fulfilfulfilling: the billing request is currently undergoing fulfilmentfulfilled: the billing request has been fulfilled and a payment
+ * createdcancelled: the billing request has been cancelled and cannot be
+ * used withStatus(String status) {
@@ -2987,9 +3074,6 @@ public BillingRequestListRequest withHeader(String headerName, String headerV
protected Map
extends ListRequest withLimit(Integer limit) {
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer`
- * are supported in supported Eurozone countries (EUR). For Eurozone countries,
- * `sepa_credit_transfer` is used as the default. Please be aware that
- * `sepa_instant_credit_transfer` may incur an additional fee for your customer.
+ * (Optional) A scheme used for Open Banking payments. Currently
+ * faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public BillingRequestTemplateListRequest withPaymentRequestScheme(
String paymentRequestScheme) {
@@ -211,7 +214,7 @@ public static final class BillingRequestTemplateCreateRequest
private String mandateRequestDescription;
private Mapmax_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public BillingRequestTemplateCreateRequest withMandateRequestConstraintsPeriodicLimits(
List
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It uses
- * GoCardless payment intelligence solution to determine if a payer is fraudulent or not.
- * The verification mechanism is based on the response and the payer may be asked to verify
- * themselves. If the feature is not available, `recommended` behaves like `minimum`.
- *
- * If you never wish to take advantage of our reduced risk products and Verified Mandates as
- * they are released in new schemes, please use the `minimum` verification preference.
- *
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * Verification preference for the mandate.
*/
public BillingRequestTemplateCreateRequest withMandateRequestVerify(
- MandateRequestVerify mandateRequestVerify) {
+ String mandateRequestVerify) {
this.mandateRequestVerify = mandateRequestVerify;
return this;
}
@@ -445,9 +433,9 @@ public BillingRequestTemplateCreateRequest withPaymentRequestAmount(
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and
- * `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in
- * supported Eurozone countries only.
+ * ISO 4217 currency code.
+ * GBP and EUR supported; GBP with your customers in
+ * the UK and for EUR with your customers in supported Eurozone countries only.
*/
public BillingRequestTemplateCreateRequest withPaymentRequestCurrency(
String paymentRequestCurrency) {
@@ -458,7 +446,6 @@ public BillingRequestTemplateCreateRequest withPaymentRequestCurrency(
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public BillingRequestTemplateCreateRequest withPaymentRequestDescription(
String paymentRequestDescription) {
@@ -492,11 +479,12 @@ public BillingRequestTemplateCreateRequest withPaymentRequestMetadata(String key
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer`
- * are supported in supported Eurozone countries (EUR). For Eurozone countries,
- * `sepa_credit_transfer` is used as the default. Please be aware that
- * `sepa_instant_credit_transfer` may incur an additional fee for your customer.
+ * (Optional) A scheme used for Open Banking payments. Currently
+ * faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public BillingRequestTemplateCreateRequest withPaymentRequestScheme(
String paymentRequestScheme) {
@@ -558,26 +546,13 @@ protected boolean hasBody() {
return true;
}
- public enum MandateRequestVerify {
- @SerializedName("minimum")
- MINIMUM, @SerializedName("recommended")
- RECOMMENDED, @SerializedName("when_available")
- WHEN_AVAILABLE, @SerializedName("always")
- ALWAYS, @SerializedName("unknown")
- UNKNOWN;
-
- @Override
- public String toString() {
- return name().toLowerCase();
- }
- }
-
public static class Links {
private String creditor;
/**
- * ID of the associated [creditor](#core-endpoints-creditors). 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;
@@ -592,15 +567,27 @@ public static class PeriodicLimits {
private Period period;
/**
- * The alignment of the period.
+ * The alignment of the period. Defaults to creation_date if not specified.
*
- * `calendar` - this will finish on the end of the current period. For example this will
- * expire on the Monday for the current week or the January for the next year.
+ * calendar
+ *
+ *
+ * week runs Monday to Sunday, month runs from the 1st to the
+ * last day of the calendar month, and year runs from 1 January to 31
+ * December. If the mandate starts partway through a period, the limit for that first
+ * period is reduced proportionally to the days remaining (e.g. a monthly limit starting
+ * on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period. For
- * example Monthly it will expire on the same day of the next month, or yearly the same
- * day of the next year.
+ * creation_date
+ *
+ *
*
+ * Note: Has no effect when period is flexible.
*/
public PeriodicLimits withAlignment(Alignment alignment) {
this.alignment = alignment;
@@ -608,9 +595,9 @@ public PeriodicLimits withAlignment(Alignment alignment) {
}
/**
- * The maximum number of payments that can be collected in this periodic limit. _Note:_
- * This is only supported for the PayTo scheme, where it is required.
+ * The maximum number of payments that can be collected in this periodic limit.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public PeriodicLimits withMaxPayments(Integer maxPayments) {
this.maxPayments = maxPayments;
@@ -618,9 +605,10 @@ public PeriodicLimits withMaxPayments(Integer maxPayments) {
}
/**
- * The maximum total amount that can be charged for all payments in this periodic limit.
- * Required for VRP.
+ * The maximum total amount that can be charged for all payments in this periodic limit,
+ * in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
this.maxTotalAmount = maxTotalAmount;
@@ -628,8 +616,9 @@ public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is provided
+ * (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this
+ * defaults to flexible.
*/
public PeriodicLimits withPeriod(Period period) {
this.period = period;
@@ -695,7 +684,6 @@ public static class MandateRequestConstraints {
* This is an optional field and if it is not supplied the agreement will be considered
* open and will not have an end date. Keep in mind the end date must take into account
* how long it will take the user to set up this agreement via the Billing Request.
- *
*/
public MandateRequestConstraints withEndDate(String endDate) {
this.endDate = endDate;
@@ -703,8 +691,9 @@ public MandateRequestConstraints withEndDate(String endDate) {
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and
- * VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public MandateRequestConstraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
this.maxAmountPerPayment = maxAmountPerPayment;
@@ -713,8 +702,8 @@ public MandateRequestConstraints withMaxAmountPerPayment(Integer maxAmountPerPay
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public MandateRequestConstraints withPaymentMethod(String paymentMethod) {
this.paymentMethod = paymentMethod;
@@ -722,7 +711,12 @@ public MandateRequestConstraints withPaymentMethod(String paymentMethod) {
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public MandateRequestConstraints withPeriodicLimits(
Listmax_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public BillingRequestTemplateUpdateRequest withMandateRequestConstraintsPeriodicLimits(
List
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It uses
- * GoCardless payment intelligence solution to determine if a payer is fraudulent or not.
- * The verification mechanism is based on the response and the payer may be asked to verify
- * themselves. If the feature is not available, `recommended` behaves like `minimum`.
- *
- * If you never wish to take advantage of our reduced risk products and Verified Mandates as
- * they are released in new schemes, please use the `minimum` verification preference.
- *
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * Verification preference for the mandate.
*/
public BillingRequestTemplateUpdateRequest withMandateRequestVerify(
- MandateRequestVerify mandateRequestVerify) {
+ String mandateRequestVerify) {
this.mandateRequestVerify = mandateRequestVerify;
return this;
}
@@ -976,9 +953,9 @@ public BillingRequestTemplateUpdateRequest withPaymentRequestAmount(
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and
- * `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in
- * supported Eurozone countries only.
+ * ISO 4217 currency code.
+ * GBP and EUR supported; GBP with your customers in
+ * the UK and for EUR with your customers in supported Eurozone countries only.
*/
public BillingRequestTemplateUpdateRequest withPaymentRequestCurrency(
String paymentRequestCurrency) {
@@ -989,7 +966,6 @@ public BillingRequestTemplateUpdateRequest withPaymentRequestCurrency(
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public BillingRequestTemplateUpdateRequest withPaymentRequestDescription(
String paymentRequestDescription) {
@@ -1023,11 +999,12 @@ public BillingRequestTemplateUpdateRequest withPaymentRequestMetadata(String key
}
/**
- * (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is
- * supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer`
- * are supported in supported Eurozone countries (EUR). For Eurozone countries,
- * `sepa_credit_transfer` is used as the default. Please be aware that
- * `sepa_instant_credit_transfer` may incur an additional fee for your customer.
+ * (Optional) A scheme used for Open Banking payments. Currently
+ * faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public BillingRequestTemplateUpdateRequest withPaymentRequestScheme(
String paymentRequestScheme) {
@@ -1081,20 +1058,6 @@ protected boolean hasBody() {
return true;
}
- public enum MandateRequestVerify {
- @SerializedName("minimum")
- MINIMUM, @SerializedName("recommended")
- RECOMMENDED, @SerializedName("when_available")
- WHEN_AVAILABLE, @SerializedName("always")
- ALWAYS, @SerializedName("unknown")
- UNKNOWN;
-
- @Override
- public String toString() {
- return name().toLowerCase();
- }
- }
-
public static class PeriodicLimits {
private Alignment alignment;
private Integer maxPayments;
@@ -1102,15 +1065,27 @@ public static class PeriodicLimits {
private Period period;
/**
- * The alignment of the period.
+ * The alignment of the period. Defaults to creation_date if not specified.
*
- * `calendar` - this will finish on the end of the current period. For example this will
- * expire on the Monday for the current week or the January for the next year.
+ * calendar
+ *
+ *
+ * week runs Monday to Sunday, month runs from the 1st to the
+ * last day of the calendar month, and year runs from 1 January to 31
+ * December. If the mandate starts partway through a period, the limit for that first
+ * period is reduced proportionally to the days remaining (e.g. a monthly limit starting
+ * on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period. For
- * example Monthly it will expire on the same day of the next month, or yearly the same
- * day of the next year.
+ * creation_date
+ *
+ *
*
+ * Note: Has no effect when period is flexible.
*/
public PeriodicLimits withAlignment(Alignment alignment) {
this.alignment = alignment;
@@ -1118,9 +1093,9 @@ public PeriodicLimits withAlignment(Alignment alignment) {
}
/**
- * The maximum number of payments that can be collected in this periodic limit. _Note:_
- * This is only supported for the PayTo scheme, where it is required.
+ * The maximum number of payments that can be collected in this periodic limit.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public PeriodicLimits withMaxPayments(Integer maxPayments) {
this.maxPayments = maxPayments;
@@ -1128,9 +1103,10 @@ public PeriodicLimits withMaxPayments(Integer maxPayments) {
}
/**
- * The maximum total amount that can be charged for all payments in this periodic limit.
- * Required for VRP.
+ * The maximum total amount that can be charged for all payments in this periodic limit,
+ * in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
this.maxTotalAmount = maxTotalAmount;
@@ -1138,8 +1114,9 @@ public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is provided
+ * (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this
+ * defaults to flexible.
*/
public PeriodicLimits withPeriod(Period period) {
this.period = period;
@@ -1205,7 +1182,6 @@ public static class MandateRequestConstraints {
* This is an optional field and if it is not supplied the agreement will be considered
* open and will not have an end date. Keep in mind the end date must take into account
* how long it will take the user to set up this agreement via the Billing Request.
- *
*/
public MandateRequestConstraints withEndDate(String endDate) {
this.endDate = endDate;
@@ -1213,8 +1189,9 @@ public MandateRequestConstraints withEndDate(String endDate) {
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and
- * VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public MandateRequestConstraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
this.maxAmountPerPayment = maxAmountPerPayment;
@@ -1223,8 +1200,8 @@ public MandateRequestConstraints withMaxAmountPerPayment(Integer maxAmountPerPay
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public MandateRequestConstraints withPaymentMethod(String paymentMethod) {
this.paymentMethod = paymentMethod;
@@ -1232,7 +1209,12 @@ public MandateRequestConstraints withPaymentMethod(String paymentMethod) {
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public MandateRequestConstraints withPeriodicLimits(
List
+ *
*/
public BillingRequestWithActionCreateWithActionsRequest withMandateRequestFundsSettlement(
MandateRequest.FundsSettlement fundsSettlement) {
@@ -279,9 +280,10 @@ public BillingRequestWithActionCreateWithActionsRequest withMandateRequestMetada
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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) {
@@ -323,26 +325,29 @@ public BillingRequestWithActionCreateWithActionsRequest withMandateRequestSweepi
/**
* Verification preference for the mandate. One of:
+ *
* managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It uses
- * GoCardless payment intelligence solution to determine if a payer is fraudulent or not.
- * The verification mechanism is based on the response and the payer may be asked to verify
- * themselves. If the feature is not available, `recommended` behaves like `minimum`.
+ * By default, all Billing Requests use the minimum: only verify if absolutely required, such as when part of scheme
+ * rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use themalways: as when_available, but fail to create the Billing
+ * Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer is
+ * fraudulent or not. The verification mechanism is based on the response and the payer may
+ * be asked to verify themselves. If the feature is not available, recommended
+ * behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified Mandates as
- * they are released in new schemes, please use the `minimum` verification preference.
+ * they are released in new schemes, please use the minimum verification
+ * preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public BillingRequestWithActionCreateWithActionsRequest withMandateRequestVerify(
MandateRequest.Verify verify) {
@@ -391,9 +396,9 @@ 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 Commercial Payment Purpose
- * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for the
- * complete list of valid codes.
+ * compliance. See
+ * VRP
+ * Commercial Payment Purpose Codes for the complete list of valid codes.
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentPurposeCode(
String paymentPurposeCode) {
@@ -434,9 +439,9 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestAppFee
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and
- * `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in
- * supported Eurozone countries only.
+ * ISO 4217 currency code.
+ * GBP and EUR supported; GBP with your customers in
+ * the UK and for EUR with your customers in supported Eurozone countries only.
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestCurrency(
String currency) {
@@ -450,7 +455,6 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestCurren
/**
* A human-readable description of the payment and/or mandate. This will be displayed to the
* payer when authorising the billing request.
- *
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestDescription(
String description) {
@@ -464,10 +468,12 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestDescri
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct`
- * will be a direct transfer from the payer's account to the merchant where invoicing will
- * be handled separately.
- *
+ *
+ *
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestFundsSettlement(
PaymentRequest.FundsSettlement fundsSettlement) {
@@ -495,7 +501,6 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestMetada
* A custom payment reference defined by the merchant. It is only available for payments on
* the PayTo scheme or payments using the Direct Funds settlement model on the Faster
* Payments scheme.
- *
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestReference(
String reference) {
@@ -507,11 +512,12 @@ public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestRefere
}
/**
- * On failure, automatically retry payments using [intelligent
- * retries](/success-plus/overview). Default is `false`.
+ * On failure, automatically retry payments using
+ * intelligent retries.
+ * Default is managed will be moved through GoCardless' account, batched, and payed
+ * out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.false.
* faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your customer.
*/
public BillingRequestWithActionCreateWithActionsRequest withPaymentRequestScheme(
String scheme) {
@@ -545,9 +552,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](https://developer.gocardless.com/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) {
@@ -683,8 +690,9 @@ public static class CollectBankAccount {
* Name of the account holder, as known by the bank. The full name provided when the
* 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 bank account
- * token](#javascript-flow-customer-bank-account-tokens).
+ * unless the request includes a customer
+ * bank account token.
*/
public CollectBankAccount withAccountHolderName(String accountHolderName) {
this.accountHolderName = accountHolderName;
@@ -692,8 +700,9 @@ public CollectBankAccount withAccountHolderName(String accountHolderName) {
}
/**
- * Bank account number - see [local details](#appendix-local-bank-details) for more
- * information. Alternatively you can provide an `iban`.
+ * Bank account number - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CollectBankAccount withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -701,8 +710,9 @@ public CollectBankAccount withAccountNumber(String accountNumber) {
}
/**
- * Account number suffix (only for bank accounts denominated in NZD) - see [local
- * details](#local-bank-details-new-zealand) for more information.
+ * Account number suffix (only for bank accounts denominated in NZD) - see local
+ * details for more information.
*/
public CollectBankAccount withAccountNumberSuffix(String accountNumberSuffix) {
this.accountNumberSuffix = accountNumberSuffix;
@@ -711,8 +721,9 @@ 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
- * details](#local-bank-details-united-states) for more information.
+ * for bank accounts in other currencies. See local
+ * details for more information.
*/
public CollectBankAccount withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -720,8 +731,9 @@ public CollectBankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CollectBankAccount withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -729,8 +741,9 @@ public CollectBankAccount withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CollectBankAccount withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -738,9 +751,10 @@ public CollectBankAccount withBranchCode(String branchCode) {
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public CollectBankAccount withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -748,8 +762,9 @@ public CollectBankAccount withCountryCode(String countryCode) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
- * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency
+ * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
+ * supported.
*/
public CollectBankAccount withCurrency(String currency) {
this.currency = currency;
@@ -757,10 +772,12 @@ public CollectBankAccount withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank
- * accounts denominated in SEK - you must supply [local
- * details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public CollectBankAccount withIban(String iban) {
this.iban = iban;
@@ -846,10 +863,11 @@ public static class Customer {
private String phoneNumber;
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are
- * provided. For Canadian customers, the use of a `company_name` value will mean that
- * any mandate created from this customer will be considered to be a "Business PAD"
- * (otherwise, any mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered
+ * to be a "Personal PAD").
*/
public Customer withCompanyName(String companyName) {
this.companyName = companyName;
@@ -866,7 +884,7 @@ public Customer withEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public Customer withFamilyName(String familyName) {
this.familyName = familyName;
@@ -874,7 +892,7 @@ public Customer withFamilyName(String familyName) {
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public Customer withGivenName(String givenName) {
this.givenName = givenName;
@@ -882,13 +900,14 @@ public Customer withGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not
- * send its own (see [compliance requirements](#appendix-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 language is
- * default to "en".
+ * ISO 639-1 code.
+ * Used as the language for notification emails sent by GoCardless if your organisation
+ * does not send 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 and a customer was linked
+ * during billing request creation, the linked customer language will be used.
+ * Otherwise, the language is default to "en".
*/
public Customer withLanguage(String language) {
this.language = language;
@@ -905,8 +924,8 @@ public Customer withMetadata(Mapauthorisation_source is
+ * set to telephone or paper.
*/
public CustomerBillingDetail withIpAddress(String ipAddress) {
this.ipAddress = ipAddress;
@@ -1026,8 +1045,8 @@ public CustomerBillingDetail withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required
- * (e.g. `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public CustomerBillingDetail withRegion(String region) {
this.region = region;
@@ -1155,9 +1174,9 @@ public static class SelectInstitution {
private String institution;
/**
- * [ISO
- * 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
- * alpha-2 code. The country code of the institution. If nothing is provided,
+ * ISO
+ * 3166-1 alpha-2 code. The country code of the institution. If nothing is provided,
* institutions with the country code 'GB' are returned by default.
*/
public SelectInstitution withCountryCode(String countryCode) {
@@ -1237,8 +1256,9 @@ public static class Links {
private String customerBankAccount;
/**
- * ID of the associated [creditor](#core-endpoints-creditors). 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;
@@ -1246,8 +1266,9 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of the [customer](#core-endpoints-customers) against which this request should be
- * made.
+ * ID of the customer
+ * against which this request should be made.
*/
public Links withCustomer(String customer) {
this.customer = customer;
@@ -1255,9 +1276,9 @@ public Links withCustomer(String customer) {
}
/**
- * (Optional) ID of the [customer_bank_account](#core-endpoints-customer-bank-accounts)
+ * (Optional) ID of the customer_bank_account
* against which this request should be made.
- *
*/
public Links withCustomerBankAccount(String customerBankAccount) {
this.customerBankAccount = customerBankAccount;
@@ -1272,15 +1293,27 @@ public static class PeriodicLimits {
private Period period;
/**
- * The alignment of the period.
+ * The alignment of the period. Defaults to creation_date if not specified.
*
- * `calendar` - this will finish on the end of the current period. For example this will
- * expire on the Monday for the current week or the January for the next year.
+ * calendar
+ *
+ *
+ * week runs Monday to Sunday, month runs from the 1st to the
+ * last day of the calendar month, and year runs from 1 January to 31
+ * December. If the mandate starts partway through a period, the limit for that first
+ * period is reduced proportionally to the days remaining (e.g. a monthly limit starting
+ * on the 15th gives roughly half the limit for that first month).
*
- * `creation_date` - this will finish on the next instance of the current period. For
- * example Monthly it will expire on the same day of the next month, or yearly the same
- * day of the next year.
+ * creation_date
+ *
+ *
*
+ * Note: Has no effect when period is flexible.
*/
public PeriodicLimits withAlignment(Alignment alignment) {
this.alignment = alignment;
@@ -1288,9 +1321,9 @@ public PeriodicLimits withAlignment(Alignment alignment) {
}
/**
- * The maximum number of payments that can be collected in this periodic limit. _Note:_
- * This is only supported for the PayTo scheme, where it is required.
+ * The maximum number of payments that can be collected in this periodic limit.
*
+ * Note: Only supported for the PayTo scheme, where it is optional.
*/
public PeriodicLimits withMaxPayments(Integer maxPayments) {
this.maxPayments = maxPayments;
@@ -1298,9 +1331,10 @@ public PeriodicLimits withMaxPayments(Integer maxPayments) {
}
/**
- * The maximum total amount that can be charged for all payments in this periodic limit.
- * Required for VRP.
+ * The maximum total amount that can be charged for all payments in this periodic limit,
+ * in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
*
+ * Note: Required for VRP. This is not permitted for the PayTo scheme.
*/
public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
this.maxTotalAmount = maxTotalAmount;
@@ -1308,8 +1342,9 @@ public PeriodicLimits withMaxTotalAmount(Integer maxTotalAmount) {
}
/**
- * The repeating period for this mandate. Defaults to flexible for PayTo if not
- * specified.
+ * The repeating period for this mandate. Required whenever a periodic limit is provided
+ * (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this
+ * defaults to flexible.
*/
public PeriodicLimits withPeriod(Period period) {
this.period = period;
@@ -1375,7 +1410,6 @@ public static class Constraints {
* This is an optional field and if it is not supplied the agreement will be considered
* open and will not have an end date. Keep in mind the end date must take into account
* how long it will take the user to set up this agreement via the Billing Request.
- *
*/
public Constraints withEndDate(String endDate) {
this.endDate = endDate;
@@ -1383,8 +1417,9 @@ public Constraints withEndDate(String endDate) {
}
/**
- * The maximum amount that can be charged for a single payment. Required for PayTo and
- * VRP.
+ * The maximum amount that can be charged for a single payment in the lowest
+ * denomination for the currency (e.g. pence in GBP, cents in EUR). Note:
+ * Required for PayTo and VRP.
*/
public Constraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
this.maxAmountPerPayment = maxAmountPerPayment;
@@ -1393,8 +1428,8 @@ public Constraints withMaxAmountPerPayment(Integer maxAmountPerPayment) {
/**
* A constraint where you can specify info (free text string) about how payments are
- * calculated. _Note:_ This is only supported for ACH and PAD schemes.
- *
+ * calculated. For use when payments vary and cannot be expressed as a fixed amount and
+ * frequency. Note: This is only supported for ACH and PAD schemes.
*/
public Constraints withPaymentMethod(String paymentMethod) {
this.paymentMethod = paymentMethod;
@@ -1402,7 +1437,12 @@ public Constraints withPaymentMethod(String paymentMethod) {
}
/**
- * List of periodic limits and constraints which apply to them
+ * Caps on the total amount and/or number of payments that can be collected within a
+ * repeating period (e.g. no more than a set amount per month), as opposed to
+ * max_amount_per_payment which caps a single payment.
+ *
+ * Note: Required for VRP, where exactly one periodic limit must be provided.
+ * Optional for PayTo.
*/
public Constraints withPeriodicLimits(List
+ *
*/
public MandateRequest withFundsSettlement(FundsSettlement fundsSettlement) {
this.fundsSettlement = fundsSettlement;
@@ -1520,9 +1560,10 @@ public MandateRequest withMetadata(Mapmanaged will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.
- *
- *
- * By default, all Billing Requests use the `recommended` verification preference. It
- * uses GoCardless payment intelligence solution to determine if a payer is fraudulent
- * or not. The verification mechanism is based on the response and the payer may be
- * asked to verify themselves. If the feature is not available, `recommended` behaves
- * like `minimum`.
+ * By default, all Billing Requests use the minimum: only verify if absolutely required, such as when part of
+ * scheme rulesrecommended: in addition to minimum, use the GoCardless
+ * payment intelligence solution to decide if a payer should be verifiedwhen_available: if verification mechanisms are available, use
+ * themalways: as when_available, but fail to create the
+ * Billing Request if a mechanism isn't availablerecommended verification
+ * preference. It uses GoCardless payment intelligence solution to determine if a payer
+ * is fraudulent or not. The verification mechanism is based on the response and the
+ * payer may be asked to verify themselves. If the feature is not available,
+ * recommended behaves like minimum.
*
* If you never wish to take advantage of our reduced risk products and Verified
- * Mandates as they are released in new schemes, please use the `minimum` verification
- * preference.
+ * Mandates as they are released in new schemes, please use the minimum
+ * verification preference.
*
- * See [Billing Requests: Creating Verified
- * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
- * for more information.
+ * See Billing
+ * Requests: Creating Verified Mandates for more information.
*/
public MandateRequest withVerify(Verify verify) {
this.verify = verify;
@@ -1651,9 +1693,10 @@ public PaymentRequest withAppFee(Integer appFee) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP`
- * and `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your
- * customers in supported Eurozone countries only.
+ * ISO 4217 currency
+ * code. GBP and EUR supported; GBP with your
+ * customers in the UK and for EUR with your customers in supported
+ * Eurozone countries only.
*/
public PaymentRequest withCurrency(String currency) {
this.currency = currency;
@@ -1663,7 +1706,6 @@ public PaymentRequest withCurrency(String currency) {
/**
* A human-readable description of the payment and/or mandate. This will be displayed to
* the payer when authorising the billing request.
- *
*/
public PaymentRequest withDescription(String description) {
this.description = description;
@@ -1673,10 +1715,12 @@ public PaymentRequest withDescription(String description) {
/**
* This field will decide how GoCardless handles settlement of funds from the customer.
*
- * - `managed` will be moved through GoCardless' account, batched, and payed out. -
- * `direct` will be a direct transfer from the payer's account to the merchant where
- * invoicing will be handled separately.
- *
+ *
+ *
*/
public PaymentRequest withFundsSettlement(FundsSettlement fundsSettlement) {
this.fundsSettlement = fundsSettlement;
@@ -1696,7 +1740,6 @@ public PaymentRequest withMetadata(Mapmanaged will be moved through GoCardless' account, batched, and
+ * payed out.direct will be a direct transfer from the payer's account to the
+ * merchant where invoicing will be handled separately.false.
* faster_payments is supported in the UK (GBP) and
+ * sepa_credit_transfer and sepa_instant_credit_transfer are
+ * supported in supported Eurozone countries (EUR). For Eurozone countries,
+ * sepa_credit_transfer is used as the default. Please be aware that
+ * sepa_instant_credit_transfer may incur an additional fee for your
* customer.
*/
public PaymentRequest withScheme(String scheme) {
diff --git a/src/main/java/com/gocardless/services/BlockService.java b/src/main/java/com/gocardless/services/BlockService.java
index bfc91b68..72faec67 100644
--- a/src/main/java/com/gocardless/services/BlockService.java
+++ b/src/main/java/com/gocardless/services/BlockService.java
@@ -23,9 +23,10 @@
*
* Please note:
*
- * - Payments and subscriptions cannot be created against a mandate in blocked state. - A mandate
- * can never be transitioned out of the blocked state.
- *
+ *
+ *
* The one exception to this is when blocking a 'bank_name'. This block will prevent bank accounts
* from being created for banks that match the given name. To ensure we match bank names correctly
* an existing bank account must be used when creating this block. Please be aware that we cannot
@@ -62,7 +63,9 @@ public BlockGetRequest get(String identity) {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your blocks.
+ * Returns a cursor-paginated
+ * list of your blocks.
*/
public BlockListRequest extends ListRequest withBefore(String before) {
}
/**
- * ID of a [Block](#core-endpoints-blocks).
+ * Type of entity we will seek to match against when blocking the mandate. This can
+ * currently be one of 'email', 'email_domain', 'bank_account', or 'bank_name'.
*/
- public BlockListRequest withBlock(String block) {
- this.block = block;
+ public BlockListRequest withBlockType(String blockType) {
+ this.blockType = blockType;
+ return this;
+ }
+
+ public BlockListRequest withCreatedAt(CreatedAt createdAt) {
+ this.createdAt = createdAt;
return this;
}
/**
- * Type of entity we will seek to match against when blocking the mandate. This can
- * currently be one of 'email', 'email_domain', 'bank_account', or 'bank_name'.
+ * Limit to records created after the specified date-time.
*/
- public BlockListRequest withBlockType(String blockType) {
- this.blockType = blockType;
+ public BlockListRequest withCreatedAtGt(String gt) {
+ if (createdAt == null) {
+ createdAt = new CreatedAt();
+ }
+ createdAt.withGt(gt);
return this;
}
/**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was created.
+ * Limit to records created on or after the specified date-time.
*/
- public BlockListRequest withCreatedAt(String createdAt) {
- this.createdAt = createdAt;
+ public BlockListRequest withCreatedAtGte(String gte) {
+ if (createdAt == null) {
+ createdAt = new CreatedAt();
+ }
+ createdAt.withGte(gte);
+ return this;
+ }
+
+ /**
+ * Limit to records created before the specified date-time.
+ */
+ public BlockListRequest withCreatedAtLt(String lt) {
+ if (createdAt == null) {
+ createdAt = new CreatedAt();
+ }
+ createdAt.withLt(lt);
+ return this;
+ }
+
+ /**
+ * Limit to records created on or before the specified date-time.
+ */
+ public BlockListRequest withCreatedAtLte(String lte) {
+ if (createdAt == null) {
+ createdAt = new CreatedAt();
+ }
+ createdAt.withLte(lte);
return this;
}
@@ -312,14 +348,6 @@ public BlockListRequest withReasonType(String reasonType) {
return this;
}
- /**
- * Fixed [timestamp](#api-usage-dates-and-times), recording when this resource was updated.
- */
- public BlockListRequest withUpdatedAt(String updatedAt) {
- this.updatedAt = updatedAt;
- return this;
- }
-
private BlockListRequest(HttpClient httpClient, ListRequestExecutor withHeader(String headerName, String headerValue) {
protected Mapbank_account_exists error if you try to create a duplicate bank account. You may
+ * wish to handle this by updating the existing record instead, the ID of which will be provided as
+ * links[creditor_bank_account] in the error response.
*
* disable_failed error if the bank account has already been
+ * disabled.
*
* A disabled bank account can be re-enabled by creating a new bank account resource with the
* same details.
@@ -97,8 +102,9 @@ public static final class CreditorBankAccountCreateRequest
/**
* Name of the account holder, as known by the bank. Usually this is the same as the name
- * stored with the linked [creditor](#core-endpoints-creditors). This field will be
- * transliterated, upcased and truncated to 18 characters.
+ * stored with the linked creditor.
+ * This field will be transliterated, upcased and truncated to 18 characters.
*/
public CreditorBankAccountCreateRequest withAccountHolderName(String accountHolderName) {
this.accountHolderName = accountHolderName;
@@ -106,8 +112,9 @@ public CreditorBankAccountCreateRequest withAccountHolderName(String accountHold
}
/**
- * Bank account number - see [local details](#appendix-local-bank-details) for more
- * information. Alternatively you can provide an `iban`.
+ * Bank account number - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CreditorBankAccountCreateRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -116,8 +123,9 @@ 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 details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public CreditorBankAccountCreateRequest withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -125,8 +133,9 @@ public CreditorBankAccountCreateRequest withAccountType(AccountType accountType)
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CreditorBankAccountCreateRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -134,8 +143,9 @@ public CreditorBankAccountCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CreditorBankAccountCreateRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -143,9 +153,10 @@ public CreditorBankAccountCreateRequest withBranchCode(String branchCode) {
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public CreditorBankAccountCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -153,8 +164,8 @@ public CreditorBankAccountCreateRequest withCountryCode(String countryCode) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public CreditorBankAccountCreateRequest withCurrency(String currency) {
this.currency = currency;
@@ -162,9 +173,12 @@ public CreditorBankAccountCreateRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
- * denominated in SEK - you must supply [local details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public CreditorBankAccountCreateRequest withIban(String iban) {
this.iban = iban;
@@ -177,7 +191,9 @@ public CreditorBankAccountCreateRequest withLinks(Links links) {
}
/**
- * ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
+ * ID of the creditor
+ * that owns this bank account.
*/
public CreditorBankAccountCreateRequest withLinksCreditor(String creditor) {
if (links == null) {
@@ -209,8 +225,8 @@ public CreditorBankAccountCreateRequest withMetadata(String key, String value) {
}
/**
- * Defaults to `true`. When this is set to `true`, it will cause this bank account to be set
- * as the account that GoCardless will pay out to.
+ * Defaults to true. When this is set to true, it will cause this
+ * bank account to be set as the account that GoCardless will pay out to.
*/
public CreditorBankAccountCreateRequest withSetAsDefaultPayoutAccount(
Boolean setAsDefaultPayoutAccount) {
@@ -278,7 +294,9 @@ public static class Links {
private String creditor;
/**
- * ID of the [creditor](#core-endpoints-creditors) that owns this bank account.
+ * ID of the creditor
+ * that owns this bank account.
*/
public Links withCreditor(String creditor) {
this.creditor = creditor;
@@ -290,8 +308,9 @@ public Links withCreditor(String creditor) {
/**
* Request class for {@link CreditorBankAccountService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank
- * accounts.
+ * Returns a cursor-paginated
+ * list of your creditor bank accounts.
*/
public static final class CreditorBankAccountListRequest
extends ListRequest withCreditor(String creditor) {
}
/**
- * If `true`, only return enabled bank accounts. If `false`, only return disabled bank
- * accounts.
+ * If true, only return enabled bank accounts. If false, only
+ * return disabled bank accounts.
*/
public CreditorBankAccountListRequest withEnabled(Boolean enabled) {
this.enabled = enabled;
@@ -535,7 +554,8 @@ protected Classdisable_failed error if the bank account has already been
+ * disabled.
*
* A disabled bank account can be re-enabled by creating a new bank account resource with the
* same details.
diff --git a/src/main/java/com/gocardless/services/CreditorService.java b/src/main/java/com/gocardless/services/CreditorService.java
index 6f442726..cadb7b6e 100644
--- a/src/main/java/com/gocardless/services/CreditorService.java
+++ b/src/main/java/com/gocardless/services/CreditorService.java
@@ -12,9 +12,11 @@
/**
* Service class for working with creditor resources.
*
- * Each [payment](#core-endpoints-payments) 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.
@@ -38,7 +40,9 @@ public CreditorCreateRequest create() {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditors.
+ * Returns a cursor-paginated
+ * list of your creditors.
*/
public CreditorListRequestACME, the bank reference
+ * of a payout sent to that creditor could be ACME-8G7Q8.
*
* This prefix is also used for refunds in EUR and GBP.
- *
*/
public CreditorCreateRequest withBankReferencePrefix(String bankReferencePrefix) {
this.bankReferencePrefix = bankReferencePrefix;
@@ -88,8 +91,9 @@ public CreditorCreateRequest withBankReferencePrefix(String bankReferencePrefix)
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public CreditorCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -97,8 +101,9 @@ public CreditorCreateRequest withCountryCode(String countryCode) {
}
/**
- * The type of business of the creditor. Currently, `individual`, `company`, `charity`,
- * `partnership`, and `trust` are supported.
+ * The type of business of the creditor. Currently, individual,
+ * company, charity, partnership, and
+ * trust are supported.
*/
public CreditorCreateRequest withCreditorType(CreditorType creditorType) {
this.creditorType = creditorType;
@@ -188,7 +193,9 @@ public String toString() {
/**
* Request class for {@link CreditorService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditors.
+ * Returns a cursor-paginated
+ * list of your creditors.
*/
public static final class CreditorListRequest extends ListRequestbank_reference_prefix was ACME, the bank reference
+ * of a payout sent to that creditor could be ACME-8G7Q8.
*
* This prefix is also used for refunds in EUR and GBP.
- *
*/
public CreditorUpdateRequest withBankReferencePrefix(String bankReferencePrefix) {
this.bankReferencePrefix = bankReferencePrefix;
@@ -472,8 +478,9 @@ public CreditorUpdateRequest withCity(String city) {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public CreditorUpdateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -486,8 +493,9 @@ public CreditorUpdateRequest withLinks(Links links) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in AUD.
+ * ID of the bank
+ * account which is set up to receive payouts in AUD.
*/
public CreditorUpdateRequest withLinksDefaultAudPayoutAccount(
String defaultAudPayoutAccount) {
@@ -499,8 +507,9 @@ public CreditorUpdateRequest withLinksDefaultAudPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in CAD.
+ * ID of the bank
+ * account which is set up to receive payouts in CAD.
*/
public CreditorUpdateRequest withLinksDefaultCadPayoutAccount(
String defaultCadPayoutAccount) {
@@ -512,8 +521,9 @@ public CreditorUpdateRequest withLinksDefaultCadPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in DKK.
+ * ID of the bank
+ * account which is set up to receive payouts in DKK.
*/
public CreditorUpdateRequest withLinksDefaultDkkPayoutAccount(
String defaultDkkPayoutAccount) {
@@ -525,8 +535,9 @@ public CreditorUpdateRequest withLinksDefaultDkkPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in EUR.
+ * ID of the bank
+ * account which is set up to receive payouts in EUR.
*/
public CreditorUpdateRequest withLinksDefaultEurPayoutAccount(
String defaultEurPayoutAccount) {
@@ -538,8 +549,9 @@ public CreditorUpdateRequest withLinksDefaultEurPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in GBP.
+ * ID of the bank
+ * account which is set up to receive payouts in GBP.
*/
public CreditorUpdateRequest withLinksDefaultGbpPayoutAccount(
String defaultGbpPayoutAccount) {
@@ -551,8 +563,9 @@ public CreditorUpdateRequest withLinksDefaultGbpPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in NZD.
+ * ID of the bank
+ * account which is set up to receive payouts in NZD.
*/
public CreditorUpdateRequest withLinksDefaultNzdPayoutAccount(
String defaultNzdPayoutAccount) {
@@ -564,8 +577,9 @@ public CreditorUpdateRequest withLinksDefaultNzdPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in SEK.
+ * ID of the bank
+ * account which is set up to receive payouts in SEK.
*/
public CreditorUpdateRequest withLinksDefaultSekPayoutAccount(
String defaultSekPayoutAccount) {
@@ -577,8 +591,9 @@ public CreditorUpdateRequest withLinksDefaultSekPayoutAccount(
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in USD.
+ * ID of the bank
+ * account which is set up to receive payouts in USD.
*/
public CreditorUpdateRequest withLinksDefaultUsdPayoutAccount(
String defaultUsdPayoutAccount) {
@@ -661,8 +676,9 @@ public static class Links {
private String defaultUsdPayoutAccount;
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in AUD.
+ * ID of the bank
+ * account which is set up to receive payouts in AUD.
*/
public Links withDefaultAudPayoutAccount(String defaultAudPayoutAccount) {
this.defaultAudPayoutAccount = defaultAudPayoutAccount;
@@ -670,8 +686,9 @@ public Links withDefaultAudPayoutAccount(String defaultAudPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in CAD.
+ * ID of the bank
+ * account which is set up to receive payouts in CAD.
*/
public Links withDefaultCadPayoutAccount(String defaultCadPayoutAccount) {
this.defaultCadPayoutAccount = defaultCadPayoutAccount;
@@ -679,8 +696,9 @@ public Links withDefaultCadPayoutAccount(String defaultCadPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in DKK.
+ * ID of the bank
+ * account which is set up to receive payouts in DKK.
*/
public Links withDefaultDkkPayoutAccount(String defaultDkkPayoutAccount) {
this.defaultDkkPayoutAccount = defaultDkkPayoutAccount;
@@ -688,8 +706,9 @@ public Links withDefaultDkkPayoutAccount(String defaultDkkPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in EUR.
+ * ID of the bank
+ * account which is set up to receive payouts in EUR.
*/
public Links withDefaultEurPayoutAccount(String defaultEurPayoutAccount) {
this.defaultEurPayoutAccount = defaultEurPayoutAccount;
@@ -697,8 +716,9 @@ public Links withDefaultEurPayoutAccount(String defaultEurPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in GBP.
+ * ID of the bank
+ * account which is set up to receive payouts in GBP.
*/
public Links withDefaultGbpPayoutAccount(String defaultGbpPayoutAccount) {
this.defaultGbpPayoutAccount = defaultGbpPayoutAccount;
@@ -706,8 +726,9 @@ public Links withDefaultGbpPayoutAccount(String defaultGbpPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in NZD.
+ * ID of the bank
+ * account which is set up to receive payouts in NZD.
*/
public Links withDefaultNzdPayoutAccount(String defaultNzdPayoutAccount) {
this.defaultNzdPayoutAccount = defaultNzdPayoutAccount;
@@ -715,8 +736,9 @@ public Links withDefaultNzdPayoutAccount(String defaultNzdPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in SEK.
+ * ID of the bank
+ * account which is set up to receive payouts in SEK.
*/
public Links withDefaultSekPayoutAccount(String defaultSekPayoutAccount) {
this.defaultSekPayoutAccount = defaultSekPayoutAccount;
@@ -724,8 +746,9 @@ public Links withDefaultSekPayoutAccount(String defaultSekPayoutAccount) {
}
/**
- * ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is set up to
- * receive payouts in USD.
+ * ID of the bank
+ * account which is set up to receive payouts in USD.
*/
public Links withDefaultUsdPayoutAccount(String defaultUsdPayoutAccount) {
this.defaultUsdPayoutAccount = defaultUsdPayoutAccount;
diff --git a/src/main/java/com/gocardless/services/CurrencyExchangeRateService.java b/src/main/java/com/gocardless/services/CurrencyExchangeRateService.java
index 6270d55f..7b8e4a13 100644
--- a/src/main/java/com/gocardless/services/CurrencyExchangeRateService.java
+++ b/src/main/java/com/gocardless/services/CurrencyExchangeRateService.java
@@ -25,7 +25,9 @@ public CurrencyExchangeRateService(HttpClient httpClient) {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all exchange rates.
+ * Returns a cursor-paginated
+ * list of all exchange rates.
*/
public CurrencyExchangeRateListRequest
extends ListRequestbank_account_exists error if you try to create a duplicate bank account. You may
+ * wish to handle this by updating the existing record instead, the ID of which will be provided as
+ * links[customer_bank_account] in the error response.
*
- * _Note:_ To ensure the customer's bank accounts are valid, verify them first using
- * [bank_details_lookups](#bank-details-lookups-perform-a-bank-details-lookup), before proceeding
- * with creating the accounts
+ * Note: To ensure the customer's bank accounts are valid, verify them first using bank_details_lookups,
+ * before proceeding with creating the accounts
*/
public class CustomerBankAccountService {
private final HttpClient httpClient;
@@ -42,21 +45,27 @@ public CustomerBankAccountService(HttpClient httpClient) {
*
* There are three different ways to supply bank account details:
*
- * - [Local details](#appendix-local-bank-details)
- *
- * - IBAN
- *
- * - [Customer Bank Account Tokens](#javascript-flow-create-a-customer-bank-account-token)
- *
- * For more information on the different fields required in each country, see [local bank
- * details](#appendix-local-bank-details).
+ *
+ *
+ * For more information on the different fields required in each country, see
+ * local
+ * bank details.
*/
public CustomerBankAccountCreateRequest create() {
return new CustomerBankAccountCreateRequest(httpClient);
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank accounts.
+ * Returns a cursor-paginated
+ * list of your bank accounts.
*/
public CustomerBankAccountListRequestdisable_failed error if the bank account has already been
+ * disabled.
*
* A disabled bank account can be re-enabled by creating a new bank account resource with the
* same details.
@@ -101,14 +111,18 @@ public CustomerBankAccountDisableRequest disable(String identity) {
*
* There are three different ways to supply bank account details:
*
- * - [Local details](#appendix-local-bank-details)
- *
- * - IBAN
- *
- * - [Customer Bank Account Tokens](#javascript-flow-create-a-customer-bank-account-token)
- *
- * For more information on the different fields required in each country, see [local bank
- * details](#appendix-local-bank-details).
+ *
+ *
+ * For more information on the different fields required in each country, see
+ * local
+ * bank details.
*/
public static final class CustomerBankAccountCreateRequest
extends IdempotentPostRequestiban.
*/
public CustomerBankAccountCreateRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -146,8 +162,9 @@ 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 details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public CustomerBankAccountCreateRequest withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -155,8 +172,9 @@ public CustomerBankAccountCreateRequest withAccountType(AccountType accountType)
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CustomerBankAccountCreateRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -164,8 +182,9 @@ public CustomerBankAccountCreateRequest withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public CustomerBankAccountCreateRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -173,9 +192,10 @@ public CustomerBankAccountCreateRequest withBranchCode(String branchCode) {
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public CustomerBankAccountCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -183,8 +203,8 @@ public CustomerBankAccountCreateRequest withCountryCode(String countryCode) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public CustomerBankAccountCreateRequest withCurrency(String currency) {
this.currency = currency;
@@ -192,9 +212,12 @@ public CustomerBankAccountCreateRequest withCurrency(String currency) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
- * denominated in SEK - you must supply [local details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public CustomerBankAccountCreateRequest withIban(String iban) {
this.iban = iban;
@@ -207,7 +230,9 @@ public CustomerBankAccountCreateRequest withLinks(Links links) {
}
/**
- * ID of the [customer](#core-endpoints-customers) that owns this bank account.
+ * ID of the customer
+ * that owns this bank account.
*/
public CustomerBankAccountCreateRequest withLinksCustomer(String customer) {
if (links == null) {
@@ -218,8 +243,9 @@ public CustomerBankAccountCreateRequest withLinksCustomer(String customer) {
}
/**
- * ID of a [customer bank account token](#javascript-flow-customer-bank-account-tokens) to
- * use in place of bank account parameters.
+ * ID of a customer
+ * bank account token to use in place of bank account parameters.
*/
public CustomerBankAccountCreateRequest withLinksCustomerBankAccountToken(
String customerBankAccountToken) {
@@ -312,7 +338,9 @@ public static class Links {
private String customerBankAccountToken;
/**
- * ID of the [customer](#core-endpoints-customers) that owns this bank account.
+ * ID of the customer
+ * that owns this bank account.
*/
public Links withCustomer(String customer) {
this.customer = customer;
@@ -320,8 +348,9 @@ public Links withCustomer(String customer) {
}
/**
- * ID of a [customer bank account token](#javascript-flow-customer-bank-account-tokens)
- * to use in place of bank account parameters.
+ * ID of a customer
+ * bank account token to use in place of bank account parameters.
*/
public Links withCustomerBankAccountToken(String customerBankAccountToken) {
this.customerBankAccountToken = customerBankAccountToken;
@@ -333,7 +362,9 @@ public Links withCustomerBankAccountToken(String customerBankAccountToken) {
/**
* Request class for {@link CustomerBankAccountService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank accounts.
+ * Returns a cursor-paginated
+ * list of your bank accounts.
*/
public static final class CustomerBankAccountListRequest
extends ListRequestdisable_failed error if the bank account has already been
+ * disabled.
*
* A disabled bank account can be re-enabled by creating a new bank account resource with the
* same details.
diff --git a/src/main/java/com/gocardless/services/CustomerNotificationService.java b/src/main/java/com/gocardless/services/CustomerNotificationService.java
index b8b9ecdf..565678ff 100644
--- a/src/main/java/com/gocardless/services/CustomerNotificationService.java
+++ b/src/main/java/com/gocardless/services/CustomerNotificationService.java
@@ -10,7 +10,7 @@
*
* Customer Notifications represent the notification which is due to be sent to a customer after an
* event has happened. The event, the resource and the customer to be notified are all identified in
- * the `links` property.
+ * the links property.
*
* Note that these are ephemeral records - once the notification has been actioned in some way, it
* is no longer visible using this API.
@@ -35,9 +35,8 @@ public CustomerNotificationService(HttpClient httpClient) {
/**
* "Handling" a notification means that you have sent the notification yourself (and don't want
* GoCardless to send it). If the notification has already been actioned, or the deadline to
- * notify has passed, this endpoint will return an `already_actioned` error and you should not
- * take further action. This endpoint takes no additional parameters.
- *
+ * notify has passed, this endpoint will return an already_actioned error and you
+ * should not take further action. This endpoint takes no additional parameters.
*/
public CustomerNotificationHandleRequest handle(String identity) {
return new CustomerNotificationHandleRequest(httpClient, identity);
@@ -48,9 +47,8 @@ public CustomerNotificationHandleRequest handle(String identity) {
*
* "Handling" a notification means that you have sent the notification yourself (and don't want
* GoCardless to send it). If the notification has already been actioned, or the deadline to
- * notify has passed, this endpoint will return an `already_actioned` error and you should not
- * take further action. This endpoint takes no additional parameters.
- *
+ * notify has passed, this endpoint will return an already_actioned error and you
+ * should not take further action. This endpoint takes no additional parameters.
*/
public static final class CustomerNotificationHandleRequest
extends PostRequestgiven_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered to
+ * be a "Personal PAD").
*/
public CustomerCreateRequest withCompanyName(String companyName) {
this.companyName = companyName;
@@ -139,8 +143,9 @@ public CustomerCreateRequest withCompanyName(String companyName) {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public CustomerCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -166,7 +171,7 @@ public CustomerCreateRequest withEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public CustomerCreateRequest withFamilyName(String familyName) {
this.familyName = familyName;
@@ -174,7 +179,7 @@ public CustomerCreateRequest withFamilyName(String familyName) {
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public CustomerCreateRequest withGivenName(String givenName) {
this.givenName = givenName;
@@ -182,12 +187,13 @@ public CustomerCreateRequest withGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not send
- * its own (see [compliance requirements](#appendix-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".
+ * ISO 639-1 code. Used
+ * as the language for notification emails sent by GoCardless if your organisation does not
+ * send 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".
*/
public CustomerCreateRequest withLanguage(String language) {
this.language = language;
@@ -216,8 +222,8 @@ public CustomerCreateRequest withMetadata(String key, String value) {
}
/**
- * [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, including
- * country code.
+ * ITU E.123 formatted phone number,
+ * including country code.
*/
public CustomerCreateRequest withPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
@@ -234,8 +240,8 @@ public CustomerCreateRequest withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public CustomerCreateRequest withRegion(String region) {
this.region = region;
@@ -299,7 +305,9 @@ protected boolean hasBody() {
/**
* Request class for {@link CustomerService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your customers.
+ * Returns a cursor-paginated
+ * list of your customers.
*/
public static final class CustomerListRequest extends ListRequest withCreatedAtLte(String lte) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public CustomerListRequest withCurrency(Currency currency) {
this.currency = currency;
@@ -400,9 +408,10 @@ public CustomerListRequest withLimit(Integer limit) {
/**
* The direction to sort in. One of:
+ *
*
- *
*/
public CustomerListRequestascdesc withSortDirection(SortDirection sortDirection) {
@@ -412,10 +421,11 @@ public CustomerListRequest withSortDirection(SortDirection sortDirection) {
/**
* Field by which to sort records. One of:
+ *
*
- *
*/
public CustomerListRequestnamecompany_namecreated_at withSortField(SortField sortField) {
@@ -682,10 +692,11 @@ public CustomerUpdateRequest withCity(String city) {
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are provided.
- * For Canadian customers, the use of a `company_name` value will mean that any mandate
- * created from this customer will be considered to be a "Business PAD" (otherwise, any
- * mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered to
+ * be a "Personal PAD").
*/
public CustomerUpdateRequest withCompanyName(String companyName) {
this.companyName = companyName;
@@ -693,8 +704,9 @@ public CustomerUpdateRequest withCompanyName(String companyName) {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public CustomerUpdateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -720,7 +732,7 @@ public CustomerUpdateRequest withEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public CustomerUpdateRequest withFamilyName(String familyName) {
this.familyName = familyName;
@@ -728,7 +740,7 @@ public CustomerUpdateRequest withFamilyName(String familyName) {
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public CustomerUpdateRequest withGivenName(String givenName) {
this.givenName = givenName;
@@ -736,12 +748,13 @@ public CustomerUpdateRequest withGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not send
- * its own (see [compliance requirements](#appendix-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".
+ * ISO 639-1 code. Used
+ * as the language for notification emails sent by GoCardless if your organisation does not
+ * send 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".
*/
public CustomerUpdateRequest withLanguage(String language) {
this.language = language;
@@ -770,8 +783,8 @@ public CustomerUpdateRequest withMetadata(String key, String value) {
}
/**
- * [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, including
- * country code.
+ * ITU E.123 formatted phone number,
+ * including country code.
*/
public CustomerUpdateRequest withPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
@@ -788,8 +801,8 @@ public CustomerUpdateRequest withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public CustomerUpdateRequest withRegion(String region) {
this.region = region;
diff --git a/src/main/java/com/gocardless/services/EventService.java b/src/main/java/com/gocardless/services/EventService.java
index 77330865..bb4e53cd 100644
--- a/src/main/java/com/gocardless/services/EventService.java
+++ b/src/main/java/com/gocardless/services/EventService.java
@@ -14,8 +14,16 @@
* Events are stored for all webhooks. An event refers to a resource which has been updated, for
* 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](#event-types) for a complete
+ * corresponding event getting included in API responses. See
+ * here for a complete
* list of event types.
+ *
+ * extends ListRequest extends ListRequestaction.
*/
public EventListRequest withAction(String action) {
this.action = action;
@@ -96,8 +120,10 @@ public EventListRequest withBefore(String before) {
}
/**
- * ID of a [billing request](#billing-requests-billing-requests). If specified, this
- * endpoint will return all events for the given billing request.
+ * ID of a billing
+ * request. If specified, this endpoint will return all events for the given billing
+ * request.
*/
public EventListRequest withBillingRequest(String billingRequest) {
this.billingRequest = billingRequest;
@@ -154,8 +180,9 @@ public EventListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of an [creditor](#core-endpoints-creditors). If specified, this endpoint will return
- * all events for the given creditor.
+ * ID of an creditor.
+ * If specified, this endpoint will return all events for the given creditor.
*/
public EventListRequest withCreditor(String creditor) {
this.creditor = creditor;
@@ -171,21 +198,22 @@ public EventListRequest withExport(String export) {
}
/**
- * Includes linked resources in the response. Must be used with the `resource_type`
- * parameter specified. The include should be one of:
+ * Includes linked resources in the response. Must be used with the
+ * resource_type parameter specified. The include should be one of:
+ *
*
- *
*/
public EventListRequestbilling_requestcreditorinstalment_schedulemandatepayer_authorisationpaymentpayoutrefundscheme_identifiersubscriptionoutbound_paymentpayment_account_transaction withInclude(Include include) {
@@ -194,8 +222,10 @@ public EventListRequest withInclude(Include include) {
}
/**
- * ID of an [instalment schedule](#core-endpoints-instalment-schedules). If specified, this
- * endpoint will return all events for the given instalment schedule.
+ * ID of an instalment
+ * schedule. If specified, this endpoint will return all events for the given instalment
+ * schedule.
*/
public EventListRequest withInstalmentSchedule(String instalmentSchedule) {
this.instalmentSchedule = instalmentSchedule;
@@ -211,8 +241,9 @@ public EventListRequest withLimit(Integer limit) {
}
/**
- * ID of a [mandate](#core-endpoints-mandates). If specified, this endpoint will return all
- * events for the given mandate.
+ * ID of a mandate. If
+ * specified, this endpoint will return all events for the given mandate.
*/
public EventListRequest withMandate(String mandate) {
this.mandate = mandate;
@@ -220,8 +251,9 @@ public EventListRequest withMandate(String mandate) {
}
/**
- * ID of an [outbound_payment](#core-endpoints-outbound-payments). If specified, this
- * endpoint will return all events for the given payment.
+ * ID of an outbound_payment.
+ * If specified, this endpoint will return all events for the given payment.
*/
public EventListRequest withOutboundPayment(String outboundPayment) {
this.outboundPayment = outboundPayment;
@@ -238,7 +270,9 @@ public EventListRequest withParentEvent(String parentEvent) {
}
/**
- * ID of a [payer authorisation](#core-endpoints-payer-authorisations).
+ * ID of a payer
+ * authorisation.
*/
public EventListRequest withPayerAuthorisation(String payerAuthorisation) {
this.payerAuthorisation = payerAuthorisation;
@@ -246,8 +280,9 @@ public EventListRequest withPayerAuthorisation(String payerAuthorisation) {
}
/**
- * ID of a [payment](#core-endpoints-payments). If specified, this endpoint will return all
- * events for the given payment.
+ * ID of a payment. If
+ * specified, this endpoint will return all events for the given payment.
*/
public EventListRequest withPayment(String payment) {
this.payment = payment;
@@ -264,8 +299,9 @@ public EventListRequest withPaymentAccountTransaction(String paymentAccountTr
}
/**
- * ID of a [payout](#core-endpoints-payouts). If specified, this endpoint will return all
- * events for the given payout.
+ * ID of a payout. If
+ * specified, this endpoint will return all events for the given payout.
*/
public EventListRequest withPayout(String payout) {
this.payout = payout;
@@ -273,8 +309,9 @@ public EventListRequest withPayout(String payout) {
}
/**
- * ID of a [refund](#core-endpoints-refunds). If specified, this endpoint will return all
- * events for the given refund.
+ * ID of a refund. If
+ * specified, this endpoint will return all events for the given refund.
*/
public EventListRequest withRefund(String refund) {
this.refund = refund;
@@ -283,24 +320,27 @@ public EventListRequest withRefund(String refund) {
/**
* Type of resource that you'd like to get all events for. Cannot be used together with the
- * `billing_request`, `creditor`, `export`,`instalment_schedule`, `mandate`,
- * `payer_authorisation`, `payment`, `payout`, `refund`, `scheme_identifier`,
- * `subscription`, `outbound_payment` or `payment_account_transaction` parameters. The type
- * can be one of:
+ * billing_request, creditor,
+ * export,instalment_schedule, mandate,
+ * payer_authorisation, payment, payout,
+ * refund, scheme_identifier, subscription,
+ * outbound_payment or payment_account_transaction parameters. The
+ * type can be one of:
+ *
*
- *
*/
public EventListRequestbilling_requestscreditorsexportsinstalment_schedulesmandatespayer_authorisationspaymentspayoutsrefundsscheme_identifierssubscriptionsoutbound_paymentspayment_account_transactions withResourceType(ResourceType resourceType) {
@@ -309,8 +349,10 @@ public EventListRequest withResourceType(ResourceType resourceType) {
}
/**
- * ID of a [scheme identifier](#core-endpoints-scheme-identifiers). If specified, this
- * endpoint will return all events for the given scheme identifier.
+ * ID of a scheme
+ * identifier. If specified, this endpoint will return all events for the given scheme
+ * identifier.
*/
public EventListRequest withSchemeIdentifier(String schemeIdentifier) {
this.schemeIdentifier = schemeIdentifier;
@@ -318,8 +360,9 @@ public EventListRequest withSchemeIdentifier(String schemeIdentifier) {
}
/**
- * ID of a [subscription](#core-endpoints-subscriptions). If specified, this endpoint will
- * return all events for the given subscription.
+ * ID of a subscription.
+ * If specified, this endpoint will return all events for the given subscription.
*/
public EventListRequest withSubscription(String subscription) {
this.subscription = subscription;
diff --git a/src/main/java/com/gocardless/services/InstalmentScheduleService.java b/src/main/java/com/gocardless/services/InstalmentScheduleService.java
index 7139fb23..460c7e7c 100644
--- a/src/main/java/com/gocardless/services/InstalmentScheduleService.java
+++ b/src/main/java/com/gocardless/services/InstalmentScheduleService.java
@@ -15,16 +15,15 @@
* Service class for working with instalment schedule resources.
*
* Instalment schedules are objects which represent a collection of related payments, with the
- * intention to collect the `total_amount` specified. The API supports both schedule-based creation
- * (similar to subscriptions) as well as explicit selection of differing payment amounts and charge
- * dates.
+ * intention to collect the total_amount specified. The API supports both
+ * schedule-based creation (similar to subscriptions) as well as explicit selection of differing
+ * payment amounts and charge dates.
*
* Unlike subscriptions, the payments are created immediately, so the instalment schedule cannot be
* modified once submitted and instead can only be cancelled (which will cancel any of the payments
* which have not yet been submitted).
*
* Customers will receive a single notification about the complete schedule of collection.
- *
*/
public class InstalmentScheduleService {
private final HttpClient httpClient;
@@ -41,14 +40,18 @@ 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 version](#instalment-schedules-create-with-schedule).
+ * the scheduling
+ * version.
*
- * The `instalments` property is an array of payment properties (`amount` and `charge_date`).
+ * The instalments property is an array of payment properties (amount
+ * and charge_date).
*
* It can take quite a while to create the associated payments, so the API will return the
- * status as `pending` initially. When processing has completed, a subsequent GET request for
- * the instalment schedule will either have the status `success` and link to the created
- * payments, or the status `error` and detailed information about the failures.
+ * status as pending initially. When processing has completed, a subsequent GET
+ * request for the instalment schedule will either have the status success and link
+ * to the created payments, or the status error and detailed information about the
+ * failures.
*/
public InstalmentScheduleCreateWithDatesRequest createWithDates() {
return new InstalmentScheduleCreateWithDatesRequest(httpClient);
@@ -57,20 +60,24 @@ 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
- * version](#instalment-schedules-create-with-dates).
+ * individual dates, please check out the alternative
+ * version.
*
* It can take quite a while to create the associated payments, so the API will return the
- * status as `pending` initially. When processing has completed, a subsequent GET request for
- * the instalment schedule will either have the status `success` and link to the created
- * payments, or the status `error` and detailed information about the failures.
+ * status as pending initially. When processing has completed, a subsequent GET
+ * request for the instalment schedule will either have the status success and link
+ * to the created payments, or the status error and detailed information about the
+ * failures.
*/
public InstalmentScheduleCreateWithScheduleRequest createWithSchedule() {
return new InstalmentScheduleCreateWithScheduleRequest(httpClient);
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your instalment schedules.
+ * Returns a cursor-paginated
+ * list of your instalment schedules.
*/
public InstalmentScheduleListRequestcancellation_failed error if the instalment schedule is
+ * already cancelled or has completed.
*/
public InstalmentScheduleCancelRequest cancel(String identity) {
return new InstalmentScheduleCancelRequest(httpClient, identity);
@@ -111,14 +118,18 @@ public InstalmentScheduleCancelRequest cancel(String identity) {
*
* 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 version](#instalment-schedules-create-with-schedule).
+ * the scheduling
+ * version.
*
- * The `instalments` property is an array of payment properties (`amount` and `charge_date`).
+ * The instalments property is an array of payment properties (amount
+ * and charge_date).
*
* It can take quite a while to create the associated payments, so the API will return the
- * status as `pending` initially. When processing has completed, a subsequent GET request for
- * the instalment schedule will either have the status `success` and link to the created
- * payments, or the status `error` and detailed information about the failures.
+ * status as pending initially. When processing has completed, a subsequent GET
+ * request for the instalment schedule will either have the status success and link
+ * to the created payments, or the status error and detailed information about the
+ * failures.
*/
public static final class InstalmentScheduleCreateWithDatesRequest
extends IdempotentPostRequestamount
+ * and charge_date. See create
+ * (with dates)
*/
public InstalmentScheduleCreateWithDatesRequest withInstalments(
Listamount
+ * and charge_date. See create
+ * (with dates)
*/
public InstalmentScheduleCreateWithDatesRequest withInstalments(Instalments instalments) {
if (this.instalments == null) {
@@ -179,8 +194,9 @@ public InstalmentScheduleCreateWithDatesRequest withLinks(Links links) {
}
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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) {
@@ -222,25 +238,76 @@ public InstalmentScheduleCreateWithDatesRequest withName(String name) {
/**
* An optional reference that will appear on your customer's bank statement. The character
- * limit for this reference is dependent on the scheme.
- * ACH - 10 characters
- * Autogiro - 11 characters
- * Bacs - 10 characters
- * BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
- * Faster Payments - 18 characters
- * PAD - scheme doesn't offer references
- * PayTo - 18 characters
- * SEPA - 140 characters
+ * limit for this reference is dependent on the scheme.
+ *
+ * ACH
+ *
+ *
+ *
+ *
+ * Autogiro
+ *
+ *
+ *
+ *
+ * Bacs
+ *
+ *
+ *
+ *
+ * BECS
+ *
+ *
+ *
+ *
+ * BECS NZ
+ *
+ *
+ *
+ *
+ * Betalingsservice
+ *
+ *
+ *
+ *
+ * Faster Payments
+ *
+ *
+ *
+ *
+ * PAD
+ *
+ *
+ *
+ *
+ * PayTo
+ *
+ *
+ *
+ *
+ * SEPA
+ *
+ *
+ *
+ *
* Note that this reference must be unique (for each merchant) for the BECS scheme as it is
* a scheme requirement.
- * false.
* max_amount_per_payment constraint.
*/
public Instalments withAmount(Integer amount) {
this.amount = amount;
@@ -353,8 +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](#core-endpoints-mandates), 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;
@@ -364,8 +441,9 @@ 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
- * requirements](#appendix-compliance-requirements)).
+ * send its own notifications (see compliance
+ * requirements).
*/
public Instalments withDescription(String description) {
this.description = description;
@@ -377,8 +455,9 @@ public static class Links {
private String mandate;
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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;
@@ -392,13 +471,15 @@ 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
- * version](#instalment-schedules-create-with-dates).
+ * individual dates, please check out the alternative
+ * version.
*
* It can take quite a while to create the associated payments, so the API will return the
- * status as `pending` initially. When processing has completed, a subsequent GET request for
- * the instalment schedule will either have the status `success` and link to the created
- * payments, or the status `error` and detailed information about the failures.
+ * status as pending initially. When processing has completed, a subsequent GET
+ * request for the instalment schedule will either have the status success and link
+ * to the created payments, or the status error and detailed information about the
+ * failures.
*/
public static final class InstalmentScheduleCreateWithScheduleRequest
extends IdempotentPostRequestinterval_units between charge dates. Must be greater than or equal
+ * to 1.
*/
public InstalmentScheduleCreateWithScheduleRequest withInstalmentsInterval(
Integer interval) {
@@ -471,7 +551,8 @@ public InstalmentScheduleCreateWithScheduleRequest withInstalmentsInterval(
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public InstalmentScheduleCreateWithScheduleRequest withInstalmentsIntervalUnit(
Instalments.IntervalUnit intervalUnit) {
@@ -483,11 +564,12 @@ public InstalmentScheduleCreateWithScheduleRequest withInstalmentsIntervalUnit(
}
/**
- * The date on which the first payment should be charged. Must be on or after the
- * [mandate](#core-endpoints-mandates)'s `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 mandate's
- * `next_possible_charge_date`
+ * The date on which the first payment should be charged. Must be on or after the mandate's
+ * 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 mandate's next_possible_charge_date
*/
public InstalmentScheduleCreateWithScheduleRequest withInstalmentsStartDate(
String startDate) {
@@ -504,8 +586,9 @@ public InstalmentScheduleCreateWithScheduleRequest withLinks(Links links) {
}
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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) {
@@ -548,25 +631,76 @@ public InstalmentScheduleCreateWithScheduleRequest withName(String name) {
/**
* An optional reference that will appear on your customer's bank statement. The character
- * limit for this reference is dependent on the scheme.
- * ACH - 10 characters
- * Autogiro - 11 characters
- * Bacs - 10 characters
- * BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
- * Faster Payments - 18 characters
- * PAD - scheme doesn't offer references
- * PayTo - 18 characters
- * SEPA - 140 characters
+ * limit for this reference is dependent on the scheme.
+ *
+ * ACH
+ *
+ *
+ *
+ *
+ * Autogiro
+ *
+ *
+ *
+ *
+ * Bacs
+ *
+ *
+ *
+ *
+ * BECS
+ *
+ *
+ *
+ *
+ * BECS NZ
+ *
+ *
+ *
+ *
+ * Betalingsservice
+ *
+ *
+ *
+ *
+ * Faster Payments
+ *
+ *
+ *
+ *
+ * PAD
+ *
+ *
+ *
+ *
+ * PayTo
+ *
+ *
+ *
+ *
+ * SEPA
+ *
+ *
+ *
+ *
* Note that this reference must be unique (for each merchant) for the BECS scheme as it is
* a scheme requirement.
- * false.
* interval_units between charge dates. Must be greater than or
+ * equal to 1.
*/
public Instalments withInterval(Integer interval) {
this.interval = interval;
@@ -691,8 +824,8 @@ public Instalments withInterval(Integer interval) {
}
/**
- * The unit of time between customer charge dates. One of `weekly`, `monthly` or
- * `yearly`.
+ * The unit of time between customer charge dates. One of weekly,
+ * monthly or yearly.
*/
public Instalments withIntervalUnit(IntervalUnit intervalUnit) {
this.intervalUnit = intervalUnit;
@@ -701,10 +834,12 @@ public Instalments withIntervalUnit(IntervalUnit intervalUnit) {
/**
* The date on which the first payment should be charged. Must be on or after the
- * [mandate](#core-endpoints-mandates)'s `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
- * mandate's `next_possible_charge_date`
+ * mandate's
+ * 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 mandate's next_possible_charge_date
*/
public Instalments withStartDate(String startDate) {
this.startDate = startDate;
@@ -729,8 +864,9 @@ public static class Links {
private String mandate;
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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;
@@ -742,7 +878,9 @@ public Links withMandate(String mandate) {
/**
* Request class for {@link InstalmentScheduleService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your instalment schedules.
+ * Returns a cursor-paginated
+ * list of your instalment schedules.
*/
public static final class InstalmentScheduleListRequest
extends ListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of the associated [customer](#core-endpoints-customers).
+ * ID of the associated customer.
*/
public InstalmentScheduleListRequest withCustomer(String customer) {
this.customer = customer;
@@ -833,8 +972,9 @@ public InstalmentScheduleListRequest withLimit(Integer limit) {
}
/**
- * ID of the associated [mandate](#core-endpoints-mandates) 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;
@@ -1094,8 +1234,8 @@ protected boolean hasBody() {
*
* Immediately cancels an instalment schedule; no further payments will be collected for it.
*
- * This will fail with a `cancellation_failed` error if the instalment schedule is already
- * cancelled or has completed.
+ * This will fail with a cancellation_failed error if the instalment schedule is
+ * already cancelled or has completed.
*/
public static final class InstalmentScheduleCancelRequest
extends PostRequest withBranchCode(String branchCode) {
}
/**
- * [ISO
- * 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
- * alpha-2 code. The country code of the institution. If nothing is provided, institutions
- * with the country code 'GB' are returned by default.
+ * ISO
+ * 3166-1 alpha-2 code. The country code of the institution. If nothing is provided,
+ * institutions with the country code 'GB' are returned by default.
*/
public InstitutionListRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -84,9 +85,9 @@ public InstitutionListRequest withCountryCode(String countryCode) {
}
/**
- * The feature that institutions support. The available options include `pis`, and
- * `vrp_sweeping`. If nothing is provided, institutions supporting 'pis' are returned by
- * default.
+ * The feature that institutions support. The available options include pis,
+ * and vrp_sweeping. If nothing is provided, institutions supporting 'pis' are
+ * returned by default.
*/
public InstitutionListRequest withFeature(String feature) {
this.feature = feature;
@@ -94,9 +95,10 @@ public InstitutionListRequest withFeature(String feature) {
}
/**
- * The scheme that institutions support. The available options include `faster_payments`,
- * `sepa_credit_transfer`, and `sepa_instant_credit_transfer`. If nothing is provided,
- * institutions supporting 'faster_payments' are returned by default.
+ * The scheme that institutions support. The available options include
+ * faster_payments, sepa_credit_transfer, and
+ * sepa_instant_credit_transfer. If nothing is provided, institutions
+ * supporting 'faster_payments' are returned by default.
*/
public InstitutionListRequest withScheme(String scheme) {
this.scheme = scheme;
@@ -165,10 +167,10 @@ public static final class InstitutionListForBillingRequestRequest
private String search;
/**
- * [ISO
- * 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
- * alpha-2 code. The country code of the institution. If nothing is provided, institutions
- * with the country code 'GB' are returned by default.
+ * ISO
+ * 3166-1 alpha-2 code. The country code of the institution. If nothing is provided,
+ * institutions with the country code 'GB' are returned by default.
*/
public InstitutionListForBillingRequestRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -199,7 +201,6 @@ public InstitutionListForBillingRequestRequest withIds(String ids) {
/**
* Indicates whether to include temporarily disabled institutions in the response. If not
* provided or set to false, only enabled institutions will be returned.
- *
*/
public InstitutionListForBillingRequestRequest withIncludeDisabled(
Boolean includeDisabled) {
diff --git a/src/main/java/com/gocardless/services/LogoService.java b/src/main/java/com/gocardless/services/LogoService.java
index 0f9ba10a..602197ef 100644
--- a/src/main/java/com/gocardless/services/LogoService.java
+++ b/src/main/java/com/gocardless/services/LogoService.java
@@ -6,8 +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](#billing-requests-billing-request-flows) 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;
@@ -26,8 +27,8 @@ 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://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
+ * and notification emails see here.
*/
public LogoCreateForCreditorRequest createForCreditor() {
return new LogoCreateForCreditorRequest(httpClient);
@@ -41,8 +42,8 @@ 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://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
+ * and notification emails see 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 the mandate import
- * entries](#mandate-import-entries-list-all-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.
+ * 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
+ * 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.
*
* record_limit_exceeded error.
*/
public MandateImportEntryCreateRequest create() {
return new MandateImportEntryCreateRequest(httpClient);
@@ -61,9 +66,8 @@ public MandateImportEntryCreateRequest create() {
* For an existing mandate import, this endpoint lists all of the entries attached.
*
* After a mandate import has been submitted, you can use this endpoint to associate records in
- * your system (using the `record_identifier` that you provided when creating the mandate
- * import).
- *
+ * your system (using the record_identifier that you provided when creating the
+ * mandate import).
*/
public MandateImportEntryListRequestrecord_limit_exceeded error.
*/
public static final class MandateImportEntryCreateRequest
extends PostRequestsepa.
*/
public MandateImportEntryCreateRequest withAmendmentOriginalCreditorId(
String originalCreditorId) {
@@ -114,7 +119,6 @@ public MandateImportEntryCreateRequest withAmendmentOriginalCreditorId(
/**
* Data about the original mandate to be moved or modified.
- *
*/
public MandateImportEntryCreateRequest withAmendmentOriginalCreditorName(
String originalCreditorName) {
@@ -127,8 +131,7 @@ public MandateImportEntryCreateRequest withAmendmentOriginalCreditorName(
/**
* The unique SEPA reference for the mandate being amended. Required if mandate import
- * scheme is `sepa`.
- *
+ * scheme is sepa.
*/
public MandateImportEntryCreateRequest withAmendmentOriginalMandateReference(
String originalMandateReference) {
@@ -148,8 +151,9 @@ public MandateImportEntryCreateRequest withBankAccount(BankAccount bankAccount)
* Name of the account holder, as known by the bank. The full name provided when the
* 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 bank account
- * token](#javascript-flow-customer-bank-account-tokens).
+ * unless the request includes a customer
+ * bank account token.
*/
public MandateImportEntryCreateRequest withBankAccountAccountHolderName(
String accountHolderName) {
@@ -161,8 +165,9 @@ public MandateImportEntryCreateRequest withBankAccountAccountHolderName(
}
/**
- * Bank account number - see [local details](#appendix-local-bank-details) for more
- * information. Alternatively you can provide an `iban`.
+ * Bank account number - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountAccountNumber(String accountNumber) {
if (bankAccount == null) {
@@ -174,8 +179,9 @@ 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 details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public MandateImportEntryCreateRequest withBankAccountAccountType(
BankAccount.AccountType accountType) {
@@ -187,8 +193,9 @@ public MandateImportEntryCreateRequest withBankAccountAccountType(
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountBankCode(String bankCode) {
if (bankAccount == null) {
@@ -199,8 +206,9 @@ public MandateImportEntryCreateRequest withBankAccountBankCode(String bankCode)
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public MandateImportEntryCreateRequest withBankAccountBranchCode(String branchCode) {
if (bankAccount == null) {
@@ -211,9 +219,10 @@ public MandateImportEntryCreateRequest withBankAccountBranchCode(String branchCo
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public MandateImportEntryCreateRequest withBankAccountCountryCode(String countryCode) {
if (bankAccount == null) {
@@ -224,9 +233,12 @@ public MandateImportEntryCreateRequest withBankAccountCountryCode(String country
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank accounts
- * denominated in SEK - you must supply [local details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public MandateImportEntryCreateRequest withBankAccountIban(String iban) {
if (bankAccount == null) {
@@ -256,8 +268,7 @@ public MandateImportEntryCreateRequest withCustomer(Customer customer) {
/**
* The first line of the customer's address. Required if mandate import scheme is either
- * `bacs` or `sepa`.
- *
+ * bacs or sepa.
*/
public MandateImportEntryCreateRequest withCustomerAddressLine1(String addressLine1) {
if (customer == null) {
@@ -301,10 +312,11 @@ public MandateImportEntryCreateRequest withCustomerCity(String city) {
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are provided.
- * For Canadian customers, the use of a `company_name` value will mean that any mandate
- * created from this customer will be considered to be a "Business PAD" (otherwise, any
- * mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered to
+ * be a "Personal PAD").
*/
public MandateImportEntryCreateRequest withCustomerCompanyName(String companyName) {
if (customer == null) {
@@ -315,8 +327,9 @@ public MandateImportEntryCreateRequest withCustomerCompanyName(String companyNam
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public MandateImportEntryCreateRequest withCustomerCountryCode(String countryCode) {
if (customer == null) {
@@ -352,7 +365,7 @@ public MandateImportEntryCreateRequest withCustomerEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public MandateImportEntryCreateRequest withCustomerFamilyName(String familyName) {
if (customer == null) {
@@ -363,7 +376,7 @@ public MandateImportEntryCreateRequest withCustomerFamilyName(String familyName)
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public MandateImportEntryCreateRequest withCustomerGivenName(String givenName) {
if (customer == null) {
@@ -374,12 +387,13 @@ public MandateImportEntryCreateRequest withCustomerGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not send
- * its own (see [compliance requirements](#appendix-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".
+ * ISO 639-1 code. Used
+ * as the language for notification emails sent by GoCardless if your organisation does not
+ * send 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".
*/
public MandateImportEntryCreateRequest withCustomerLanguage(String language) {
if (customer == null) {
@@ -402,8 +416,8 @@ public MandateImportEntryCreateRequest withCustomerMetadata(Mapbacs
+ * or sepa.
*/
public MandateImportEntryCreateRequest withCustomerPostalCode(String postalCode) {
if (customer == null) {
@@ -427,8 +441,8 @@ public MandateImportEntryCreateRequest withCustomerPostalCode(String postalCode)
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public MandateImportEntryCreateRequest withCustomerRegion(String region) {
if (customer == null) {
@@ -474,14 +488,13 @@ public MandateImportEntryCreateRequest withMandate(Mandate mandate) {
}
/**
- * This field is ACH specific, sometimes referred to as [SEC
- * code](https://www.moderntreasury.com/learn/sec-codes).
+ * This field is ACH specific, sometimes referred to as
+ * SEC code.
*
* This is the way that the payer gives authorisation to the merchant. web: Authorisation is
* Internet Initiated or via Mobile Entry (maps to SEC code: WEB) telephone: Authorisation
* is provided orally over telephone (maps to SEC code: TEL) paper: Authorisation is
* provided in writing and signed, or similarly authenticated (maps to SEC code: PPD)
- *
*/
public MandateImportEntryCreateRequest withMandateAuthorisationSource(
Mandate.AuthorisationSource authorisationSource) {
@@ -505,9 +518,10 @@ public MandateImportEntryCreateRequest withMandateMetadata(Mapsepa.
*/
public Amendment withOriginalCreditorId(String originalCreditorId) {
this.originalCreditorId = originalCreditorId;
@@ -573,7 +585,6 @@ public Amendment withOriginalCreditorId(String originalCreditorId) {
/**
* Data about the original mandate to be moved or modified.
- *
*/
public Amendment withOriginalCreditorName(String originalCreditorName) {
this.originalCreditorName = originalCreditorName;
@@ -582,8 +593,7 @@ public Amendment withOriginalCreditorName(String originalCreditorName) {
/**
* The unique SEPA reference for the mandate being amended. Required if mandate import
- * scheme is `sepa`.
- *
+ * scheme is sepa.
*/
public Amendment withOriginalMandateReference(String originalMandateReference) {
this.originalMandateReference = originalMandateReference;
@@ -605,8 +615,9 @@ public static class BankAccount {
* Name of the account holder, as known by the bank. The full name provided when the
* 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 bank account
- * token](#javascript-flow-customer-bank-account-tokens).
+ * unless the request includes a customer
+ * bank account token.
*/
public BankAccount withAccountHolderName(String accountHolderName) {
this.accountHolderName = accountHolderName;
@@ -614,8 +625,9 @@ public BankAccount withAccountHolderName(String accountHolderName) {
}
/**
- * Bank account number - see [local details](#appendix-local-bank-details) for more
- * information. Alternatively you can provide an `iban`.
+ * Bank account number - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BankAccount withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -624,8 +636,9 @@ 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
- * details](#local-bank-details-united-states) for more information.
+ * for bank accounts in other currencies. See local
+ * details for more information.
*/
public BankAccount withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -633,8 +646,9 @@ public BankAccount withAccountType(AccountType accountType) {
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -642,8 +656,9 @@ public BankAccount withBankCode(String bankCode) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public BankAccount withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -651,9 +666,10 @@ public BankAccount withBranchCode(String branchCode) {
}
/**
- * [ISO 3166-1 alpha-2
- * code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
- * Defaults to the country code of the `iban` if supplied, otherwise is required.
+ * ISO
+ * 3166-1 alpha-2 code. Defaults to the country code of the iban if
+ * supplied, otherwise is required.
*/
public BankAccount withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -661,10 +677,12 @@ public BankAccount withCountryCode(String countryCode) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs are not accepted for Swedish bank
- * accounts denominated in SEK - you must supply [local
- * details](#local-bank-details-sweden).
+ * 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
+ * details.
*/
public BankAccount withIban(String iban) {
this.iban = iban;
@@ -713,8 +731,7 @@ public static class Customer {
/**
* The first line of the customer's address. Required if mandate import scheme is either
- * `bacs` or `sepa`.
- *
+ * bacs or sepa.
*/
public Customer withAddressLine1(String addressLine1) {
this.addressLine1 = addressLine1;
@@ -746,10 +763,11 @@ public Customer withCity(String city) {
}
/**
- * Customer's company name. Required unless a `given_name` and `family_name` are
- * provided. For Canadian customers, the use of a `company_name` value will mean that
- * any mandate created from this customer will be considered to be a "Business PAD"
- * (otherwise, any mandate will be considered to be a "Personal PAD").
+ * Customer's company name. Required unless a given_name and
+ * family_name are provided. For Canadian customers, the use of a
+ * company_name value will mean that any mandate created from this customer
+ * will be considered to be a "Business PAD" (otherwise, any mandate will be considered
+ * to be a "Personal PAD").
*/
public Customer withCompanyName(String companyName) {
this.companyName = companyName;
@@ -757,8 +775,9 @@ public Customer withCompanyName(String companyName) {
}
/**
- * [ISO 3166-1 alpha-2
- * code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+ * ISO
+ * 3166-1 alpha-2 code.
*/
public Customer withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -784,7 +803,7 @@ public Customer withEmail(String email) {
}
/**
- * Customer's surname. Required unless a `company_name` is provided.
+ * Customer's surname. Required unless a company_name is provided.
*/
public Customer withFamilyName(String familyName) {
this.familyName = familyName;
@@ -792,7 +811,7 @@ public Customer withFamilyName(String familyName) {
}
/**
- * Customer's first name. Required unless a `company_name` is provided.
+ * Customer's first name. Required unless a company_name is provided.
*/
public Customer withGivenName(String givenName) {
this.givenName = givenName;
@@ -800,12 +819,13 @@ public Customer withGivenName(String givenName) {
}
/**
- * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the
- * language for notification emails sent by GoCardless if your organisation does not
- * send its own (see [compliance requirements](#appendix-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".
+ * ISO 639-1 code.
+ * Used as the language for notification emails sent by GoCardless if your organisation
+ * does not send 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".
*/
public Customer withLanguage(String language) {
this.language = language;
@@ -822,8 +842,8 @@ public Customer withMetadata(Mapbacs or sepa.
*/
public Customer withPostalCode(String postalCode) {
this.postalCode = postalCode;
@@ -842,8 +861,8 @@ public Customer withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required
- * (e.g. `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public Customer withRegion(String region) {
this.region = region;
@@ -880,15 +899,14 @@ public static class Mandate {
private String reference;
/**
- * This field is ACH specific, sometimes referred to as [SEC
- * code](https://www.moderntreasury.com/learn/sec-codes).
+ * This field is ACH specific, sometimes referred to as
+ * SEC code.
*
* This is the way that the payer gives authorisation to the merchant. web:
* Authorisation is Internet Initiated or via Mobile Entry (maps to SEC code: WEB)
* telephone: Authorisation is provided orally over telephone (maps to SEC code: TEL)
* paper: Authorisation is provided in writing and signed, or similarly authenticated
* (maps to SEC code: PPD)
- *
*/
public Mandate withAuthorisationSource(AuthorisationSource authorisationSource) {
this.authorisationSource = authorisationSource;
@@ -905,9 +923,10 @@ public Mandate withMetadata(Maprecord_identifier that you provided when creating the
+ * mandate import).
*/
public static final class MandateImportEntryListRequest
extends ListRequest withMandateImport(String mandateImport)
/**
* One of:
+ *
*
- *
*/
public MandateImportEntryListRequestsucessfully_processed: the entry has been imported and the associated
+ * records created.unsuccessfully_processed: the entry could not be processed due to an
+ * error, see the 'processing_errors' value withStatus(Status status) {
diff --git a/src/main/java/com/gocardless/services/MandateImportService.java b/src/main/java/com/gocardless/services/MandateImportService.java
index 1e3abb82..a2c43acb 100644
--- a/src/main/java/com/gocardless/services/MandateImportService.java
+++ b/src/main/java/com/gocardless/services/MandateImportService.java
@@ -14,27 +14,40 @@
*
* The process is as follows:
*
- * 1. [Create a mandate import](#mandate-imports-create-a-new-mandate-import) 2. [Add
- * entries](#mandate-import-entries-add-a-mandate-import-entry) to the import 3.
- * [Submit](#mandate-imports-submit-a-mandate-import) the import 4. Wait until a member of the
- * GoCardless team approves the import, at which point the mandates will be created 5. [Link up the
- * mandates](#mandate-import-entries-list-all-mandate-import-entries) in your system
- *
+ *
+ *
* When you add entries to your mandate import, they are not turned into actual mandates until the
* mandate import is submitted by you via the API, and then processed by a member of the GoCardless
* team. When that happens, a mandate will be created for each entry in the import.
*
- * We will issue a `mandate_created` webhook for each entry, which will be the same as the webhooks
- * triggered when [ creating a mandate ](#mandates-create-a-mandate) using the mandates API. Once
- * these webhooks start arriving, any reconciliation can now be accomplished by [checking the
- * current status](#mandate-imports-get-a-mandate-import) of the mandate import and [linking up the
- * mandates to your system](#mandate-import-entries-list-all-mandate-import-entries).
+ * We will issue a mandate_created webhook for each entry, which will be the same as
+ * the webhooks triggered when
+ * 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
+ * up the mandates to your system.
*
* Accept-Language header
+ * when creating the PDF mandate to the relevant
+ * ISO 639-1 language code
+ * supported for the scheme.
*
* | Scheme | Supported languages | | :--------------- |
* :-------------------------------------------------------------------------------------------------------------------------------------------
- * | | ACH | English (`en`) | | Autogiro | English (`en`), Swedish (`sv`) | | Bacs | English
- * (`en`) | | BECS | English (`en`) | | BECS NZ | English (`en`) | | Betalingsservice | Danish
- * (`da`), English (`en`) | | PAD | English (`en`) | | SEPA Core | Danish (`da`), Dutch (`nl`),
- * English (`en`), French (`fr`), German (`de`), Italian (`it`), Portuguese (`pt`), Spanish
- * (`es`), Swedish (`sv`) |
+ * | | ACH | English (en) | | Autogiro | English (en), Swedish
+ * (sv) | | Bacs | English (en) | | BECS | English (en) |
+ * | BECS NZ | English (en) | | Betalingsservice | Danish (da),
+ * English (en) | | PAD | English (en) | | SEPA Core | Danish
+ * (da), Dutch (nl), English (en), French
+ * (fr), German (de), Italian (it), Portuguese
+ * (pt), Spanish (es), Swedish (sv) |
*/
public MandatePdfCreateRequest create() {
return new MandatePdfCreateRequest(httpClient);
@@ -52,22 +56,25 @@ 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](#core-endpoints-mandates).
+ * or inferred from the ID of an existing mandate.
*
* By default, we'll generate PDF mandates in English.
*
- * To generate a PDF mandate in another language, set the `Accept-Language` header when creating
- * the PDF mandate to the relevant [ISO
- * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code supported for the
- * scheme.
+ * To generate a PDF mandate in another language, set the Accept-Language header
+ * when creating the PDF mandate to the relevant
+ * ISO 639-1 language code
+ * supported for the scheme.
*
* | Scheme | Supported languages | | :--------------- |
* :-------------------------------------------------------------------------------------------------------------------------------------------
- * | | ACH | English (`en`) | | Autogiro | English (`en`), Swedish (`sv`) | | Bacs | English
- * (`en`) | | BECS | English (`en`) | | BECS NZ | English (`en`) | | Betalingsservice | Danish
- * (`da`), English (`en`) | | PAD | English (`en`) | | SEPA Core | Danish (`da`), Dutch (`nl`),
- * English (`en`), French (`fr`), German (`de`), Italian (`it`), Portuguese (`pt`), Spanish
- * (`es`), Swedish (`sv`) |
+ * | | ACH | English (en) | | Autogiro | English (en), Swedish
+ * (sv) | | Bacs | English (en) | | BECS | English (en) |
+ * | BECS NZ | English (en) | | Betalingsservice | Danish (da),
+ * English (en) | | PAD | English (en) | | SEPA Core | Danish
+ * (da), Dutch (nl), English (en), French
+ * (fr), German (de), Italian (it), Portuguese
+ * (pt), Spanish (es), Swedish (sv) |
*/
public static final class MandatePdfCreateRequest extends PostRequestiban.
*/
public MandatePdfCreateRequest withAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
@@ -118,8 +128,9 @@ 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 details](#local-bank-details-united-states)
- * for more information.
+ * bank accounts in other currencies. See local
+ * details for more information.
*/
public MandatePdfCreateRequest withAccountType(AccountType accountType) {
this.accountType = accountType;
@@ -151,8 +162,9 @@ public MandatePdfCreateRequest withAddressLine3(String addressLine3) {
}
/**
- * Bank code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Bank code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public MandatePdfCreateRequest withBankCode(String bankCode) {
this.bankCode = bankCode;
@@ -160,8 +172,9 @@ public MandatePdfCreateRequest withBankCode(String bankCode) {
}
/**
- * SWIFT BIC. Will be derived automatically if a valid `iban` or [local
- * details](#appendix-local-bank-details) are provided.
+ * SWIFT BIC. Will be derived automatically if a valid iban or local
+ * details are provided.
*/
public MandatePdfCreateRequest withBic(String bic) {
this.bic = bic;
@@ -169,8 +182,9 @@ public MandatePdfCreateRequest withBic(String bic) {
}
/**
- * Branch code - see [local details](#appendix-local-bank-details) for more information.
- * Alternatively you can provide an `iban`.
+ * Branch code - see local
+ * details for more information. Alternatively you can provide an iban.
*/
public MandatePdfCreateRequest withBranchCode(String branchCode) {
this.branchCode = branchCode;
@@ -195,9 +209,9 @@ public MandatePdfCreateRequest withCompanyName(String companyName) {
}
/**
- * [ISO
- * 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
- * alpha-2 code. Required if providing local details.
+ * ISO
+ * 3166-1 alpha-2 code. Required if providing local details.
*/
public MandatePdfCreateRequest withCountryCode(String countryCode) {
this.countryCode = countryCode;
@@ -215,7 +229,7 @@ public MandatePdfCreateRequest withDanishIdentityNumber(String danishIdentityNum
/**
* The customer's family name (i.e. last name). Used to populate the "Customer Name or
- * Company name" field on the PDF. Ignored if `company_name` is provided.
+ * Company name" field on the PDF. Ignored if company_name is provided.
*/
public MandatePdfCreateRequest withFamilyName(String familyName) {
this.familyName = familyName;
@@ -224,7 +238,7 @@ public MandatePdfCreateRequest withFamilyName(String familyName) {
/**
* The customer's given name (i.e. first name). Used to populate the "Customer Name or
- * Company name" field on the PDF. Ignored if `company_name` is provided.
+ * Company name" field on the PDF. Ignored if company_name is provided.
*/
public MandatePdfCreateRequest withGivenName(String givenName) {
this.givenName = givenName;
@@ -232,8 +246,9 @@ public MandatePdfCreateRequest withGivenName(String givenName) {
}
/**
- * International Bank Account Number. Alternatively you can provide [local
- * details](#appendix-local-bank-details). IBANs cannot be provided for Autogiro mandates.
+ * International Bank Account Number. Alternatively you can provide local
+ * details. IBANs cannot be provided for Autogiro mandates.
*/
public MandatePdfCreateRequest withIban(String iban) {
this.iban = iban;
@@ -246,8 +261,9 @@ public MandatePdfCreateRequest withLinks(Links links) {
}
/**
- * ID of an existing [creditor](#core-endpoints-creditors). 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) {
@@ -258,9 +274,10 @@ public MandatePdfCreateRequest withLinksCreditor(String creditor) {
}
/**
- * ID of an existing [mandate](#core-endpoints-mandates) 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) {
@@ -306,8 +323,8 @@ public MandatePdfCreateRequest withPostalCode(String postalCode) {
/**
* The customer's address region, county or department. For US customers a 2 letter
- * [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g.
- * `CA` for California).
+ * ISO3166-2:US state code is
+ * required (e.g. CA for California).
*/
public MandatePdfCreateRequest withRegion(String region) {
this.region = region;
@@ -317,7 +334,9 @@ 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 details](#appendix-local-bank-details) including a `country_code`.
+ * iban, or local
+ * details including a country_code.
*/
public MandatePdfCreateRequest withScheme(String scheme) {
this.scheme = scheme;
@@ -335,7 +354,7 @@ public MandatePdfCreateRequest withSignatureDate(String signatureDate) {
/**
* For American customers only. Subscription amount being authorised by the mandate. In the
* lowest denomination for the currency (cents in USD). Is required if
- * `subscription_frequency` has been provided.
+ * subscription_frequency has been provided.
*/
public MandatePdfCreateRequest withSubscriptionAmount(Integer subscriptionAmount) {
this.subscriptionAmount = subscriptionAmount;
@@ -344,8 +363,8 @@ public MandatePdfCreateRequest withSubscriptionAmount(Integer subscriptionAmount
/**
* For American customers only. Frequency of the subscription being authorised by the
- * mandate. One of `weekly`, `monthly` or `yearly`. Is required if `subscription_amount` has
- * been provided.
+ * mandate. One of weekly, monthly or yearly. Is
+ * required if subscription_amount has been provided.
*/
public MandatePdfCreateRequest withSubscriptionFrequency(String subscriptionFrequency) {
this.subscriptionFrequency = subscriptionFrequency;
@@ -407,8 +426,9 @@ public static class Links {
private String mandate;
/**
- * ID of an existing [creditor](#core-endpoints-creditors). 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;
@@ -416,9 +436,10 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of an existing [mandate](#core-endpoints-mandates) 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 1f7dd228..a535a148 100644
--- a/src/main/java/com/gocardless/services/MandateService.java
+++ b/src/main/java/com/gocardless/services/MandateService.java
@@ -14,10 +14,12 @@
/**
* Service class for working with mandate resources.
*
- * Mandates represent the Direct Debit mandate with a [customer](#core-endpoints-customers).
+ * Mandates represent the Direct Debit mandate with a
+ * customer.
*
- * GoCardless will notify you via a [webhook](#appendix-webhooks) whenever the status of a mandate
- * changes.
+ * GoCardless will notify you via a
+ * webhook whenever
+ * the status of a mandate changes.
*/
public class MandateService {
private final HttpClient httpClient;
@@ -38,7 +40,9 @@ public MandateCreateRequest create() {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your mandates.
+ * Returns a cursor-paginated
+ * list of your mandates.
*/
public MandateListRequestcancellation_failed error if the mandate is already
+ * cancelled.
*/
public MandateCancelRequest cancel(String identity) {
return new MandateCancelRequest(httpClient, identity);
@@ -74,13 +79,14 @@ public MandateCancelRequest cancel(String identity) {
/**
* Reinstates a cancelled or expired mandate to the banks.
- * You will receive a `resubmission_requested` webhook, but after that reinstating the mandate
- * follows the same process as its initial creation, so you will receive a `submitted` webhook,
- * followed by a `reinstated` or `failed` webhook up to two working days later. Any metadata
- * supplied to this endpoint will be stored on the `resubmission_requested` event it causes.
+ * You will receive a resubmission_requested webhook, but after that reinstating
+ * the mandate follows the same process as its initial creation, so you will receive a
+ * submitted webhook, followed by a reinstated or failed
+ * webhook up to two working days later. Any metadata supplied to this endpoint will be stored
+ * on the resubmission_requested event it causes.
*
- * This will fail with a `mandate_not_inactive` error if the mandate is already being submitted,
- * or is active.
+ * This will fail with a mandate_not_inactive error if the mandate is already being
+ * submitted, or is active.
*
* Mandates can be resubmitted up to 10 times.
*/
@@ -102,14 +108,13 @@ public static final class MandateCreateRequest extends IdempotentPostRequestauthorisation_source is set
+ * to telephone or paper.
*/
public MandateCreateRequest withPayerIpAddress(String payerIpAddress) {
this.payerIpAddress = payerIpAddress;
@@ -182,9 +188,10 @@ public MandateCreateRequest withPayerIpAddress(String payerIpAddress) {
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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 MandateCreateRequest withReference(String reference) {
this.reference = reference;
@@ -262,8 +269,9 @@ public static class Links {
private String customerBankAccount;
/**
- * ID of the associated [creditor](#core-endpoints-creditors). 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;
@@ -271,8 +279,9 @@ public Links withCreditor(String creditor) {
}
/**
- * ID of the associated [customer bank account](#core-endpoints-customer-bank-accounts)
- * which the mandate is created and submits payments against.
+ * ID of the associated customer
+ * bank account which the mandate is created and submits payments against.
*/
public Links withCustomerBankAccount(String customerBankAccount) {
this.customerBankAccount = customerBankAccount;
@@ -284,7 +293,9 @@ public Links withCustomerBankAccount(String customerBankAccount) {
/**
* Request class for {@link MandateService#list }.
*
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your mandates.
+ * Returns a cursor-paginated
+ * list of your mandates.
*/
public static final class MandateListRequest extends ListRequest withCreatedAtLte(String lte) {
}
/**
- * ID of a [creditor](#core-endpoints-creditors). If specified, this endpoint will return
- * all mandates for the given creditor. Cannot be used in conjunction with `customer` or
- * `customer_bank_account`
+ * 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
*/
public MandateListRequest withCreditor(String creditor) {
this.creditor = creditor;
@@ -372,9 +384,10 @@ public MandateListRequest withCreditor(String creditor) {
}
/**
- * ID of a [customer](#core-endpoints-customers). If specified, this endpoint will return
- * all mandates for the given customer. Cannot be used in conjunction with
- * `customer_bank_account` or `creditor`
+ * 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
*/
public MandateListRequest withCustomer(String customer) {
this.customer = customer;
@@ -382,9 +395,11 @@ public MandateListRequest withCustomer(String customer) {
}
/**
- * ID of a [customer bank account](#core-endpoints-customer-bank-accounts). If specified,
- * this endpoint will return all mandates for the given bank account. Cannot be used in
- * conjunction with `customer` or `creditor`
+ * 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
*/
public MandateListRequest withCustomerBankAccount(String customerBankAccount) {
this.customerBankAccount = customerBankAccount;
@@ -408,9 +423,10 @@ public MandateListRequest withMandateType(String mandateType) {
}
/**
- * Unique reference. Different schemes have different length and [character
- * set](#appendix-character-sets) 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;
@@ -705,7 +721,8 @@ protected boolean hasBody() {
* Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied
* to this endpoint will be stored on the mandate cancellation event it causes.
*
- * This will fail with a `cancellation_failed` error if the mandate is already cancelled.
+ * This will fail with a cancellation_failed error if the mandate is already
+ * cancelled.
*/
public static final class MandateCancelRequest extends PostRequestresubmission_requested webhook, but after that reinstating
+ * the mandate follows the same process as its initial creation, so you will receive a
+ * submitted webhook, followed by a reinstated or failed
+ * webhook up to two working days later. Any metadata supplied to this endpoint will be stored
+ * on the resubmission_requested event it causes.
*
- * This will fail with a `mandate_not_inactive` error if the mandate is already being submitted,
- * or is active.
+ * This will fail with a mandate_not_inactive error if the mandate is already being
+ * submitted, or is active.
*
* Mandates can be resubmitted up to 10 times.
*/
diff --git a/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java b/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
index 75bbbe8e..161c26d2 100644
--- a/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
+++ b/src/main/java/com/gocardless/services/NegativeBalanceLimitService.java
@@ -14,7 +14,6 @@
* The negative balance limit is a threshold for the creditor balance beyond which refunds are not
* permitted. The default limit is zero — refunds are not permitted if the creditor has a negative
* balance. The limit can be changed on a per-creditor basis.
- *
*/
public class NegativeBalanceLimitService {
private final HttpClient httpClient;
@@ -29,7 +28,9 @@ public NegativeBalanceLimitService(HttpClient httpClient) {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of negative balance limits.
+ * Returns a cursor-paginated
+ * list of negative balance limits.
*/
public NegativeBalanceLimitListRequest
extends ListRequest withCreditor(String creditor) {
}
/**
- * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
- * "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
+ * ISO 4217 currency code.
+ * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public NegativeBalanceLimitListRequest withCurrency(Currency currency) {
this.currency = currency;
diff --git a/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java b/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
index e4ca2fcd..b558ff28 100644
--- a/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
+++ b/src/main/java/com/gocardless/services/OutboundPaymentImportEntryService.java
@@ -26,8 +26,9 @@ public OutboundPaymentImportEntryService(HttpClient httpClient) {
}
/**
- * Returns a [cursor-paginated](#api-usage-cursor-pagination) list of the entries for a given
- * outbound payment import.
+ * Returns a