com.gocardless.resources.PayerAuthorisation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gocardless-pro Show documentation
Show all versions of gocardless-pro Show documentation
Client library for accessing the GoCardless Pro API
package com.gocardless.resources;
import com.google.gson.annotations.SerializedName;
import java.util.List;
import java.util.Map;
/**
* Represents a payer authorisation resource returned from the API.
*
*
* Don't use Payer Authorisations for new integrations. It is deprecated in favour of
* Billing
* Requests. Use Billing Requests to build any future integrations.
*
*
* Payer Authorisation resource acts as a wrapper for creating customer, bank account and mandate
* details in a single request. PayerAuthorisation API enables the integrators to build their own
* custom payment pages.
*
* The process to use the Payer Authorisation API is as follows:
*
* 1. Create a Payer Authorisation, either empty or with already available information 2. Update the
* authorisation with additional information or fix any mistakes 3. Submit the authorisation, after
* the payer has reviewed their information 4. [coming soon] Redirect the payer to the verification
* mechanisms from the response of the Submit request (this will be introduced as a non-breaking
* change) 5. Confirm the authorisation to indicate that the resources can be created
*
* 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:
*
* - Listen to
payer_authorisation_completed
* webhook (recommended)
* - Poll the GET
* endpoint
* - Poll the GET events API
*
https://api.gocardless.com/events?payer_authorisation={id}&action=completed
*
*
*
* 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`
* 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 class PayerAuthorisation {
private PayerAuthorisation() {
// blank to prevent instantiation
}
private BankAccount bankAccount;
private String createdAt;
private Customer customer;
private String id;
private List incompleteFields;
private Links links;
private Mandate mandate;
private Status status;
/**
* All details required for the creation of a [Customer Bank
* Account](#core-endpoints-customer-bank-accounts).
*/
public BankAccount getBankAccount() {
return bankAccount;
}
/**
* [Timestamp](#api-usage-time-zones--dates), recording when this Payer Authorisation was
* created.
*/
public String getCreatedAt() {
return createdAt;
}
/**
* All details required for the creation of a [Customer](#core-endpoints-customers).
*/
public Customer getCustomer() {
return customer;
}
/**
* Unique identifier, beginning with "PA".
*/
public String getId() {
return id;
}
/**
* An array of fields which are missing and is required to set up the mandate.
*/
public List getIncompleteFields() {
return incompleteFields;
}
/**
* IDs of the created resources. Available after the Payer Authorisation is completed.
*/
public Links getLinks() {
return links;
}
/**
* All details required for the creation of a [Mandate](#core-endpoints-mandates).
*/
public Mandate getMandate() {
return mandate;
}
/**
* One of:
*
* - `created`: The PayerAuthorisation has been created, and not been confirmed yet
* - `submitted`: The payer information has been submitted
* - `confirmed`: PayerAuthorisation is confirmed and resources are ready to be created
* - `completed`: The PayerAuthorisation has been completed and customer, bank_account and
* mandate has been created
* - `failed`: The PayerAuthorisation has failed and customer, bank_account and mandate is not
* created
*
*/
public Status getStatus() {
return status;
}
public enum Status {
@SerializedName("created")
CREATED, @SerializedName("submitted")
SUBMITTED, @SerializedName("confirmed")
CONFIRMED, @SerializedName("completed")
COMPLETED, @SerializedName("failed")
FAILED, @SerializedName("unknown")
UNKNOWN
}
/**
* 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).
*/
public static class BankAccount {
private BankAccount() {
// blank to prevent instantiation
}
private String accountHolderName;
private String accountNumber;
private String accountNumberEnding;
private String accountNumberSuffix;
private AccountType accountType;
private String bankCode;
private String branchCode;
private String countryCode;
private String currency;
private String iban;
private Map metadata;
/**
* 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. This field is required unless the
* request includes a [customer bank account
* token](#javascript-flow-customer-bank-account-tokens).
*/
public String getAccountHolderName() {
return accountHolderName;
}
/**
* Bank account number - see [local details](#appendix-local-bank-details) for more
* information. Alternatively you can provide an `iban`.
*/
public String getAccountNumber() {
return accountNumber;
}
/**
* The last few digits of the account number. Currently 4 digits for NZD bank accounts and 2
* digits for other currencies.
*/
public String getAccountNumberEnding() {
return accountNumberEnding;
}
/**
* Account number suffix (only for bank accounts denominated in NZD) - see [local
* details](#local-bank-details-new-zealand) for more information.
*/
public String getAccountNumberSuffix() {
return 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.
*/
public AccountType getAccountType() {
return accountType;
}
/**
* Bank code - see [local details](#appendix-local-bank-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`.
*/
public String getBranchCode() {
return branchCode;
}
/**
* [ISO 3166-1 alpha-2
* code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
* Defaults to the country code of the `iban` if supplied, otherwise is required.
*/
public String getCountryCode() {
return countryCode;
}
/**
* [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently
* "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
*/
public 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).
*/
public String getIban() {
return iban;
}
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
* characters and values up to 500 characters.
*/
public Map getMetadata() {
return metadata;
}
public enum AccountType {
@SerializedName("savings")
SAVINGS, @SerializedName("checking")
CHECKING, @SerializedName("unknown")
UNKNOWN
}
}
/**
* Represents a customer resource returned from the API.
*
* All details required for the creation of a [Customer](#core-endpoints-customers).
*/
public static class Customer {
private Customer() {
// blank to prevent instantiation
}
private String addressLine1;
private String addressLine2;
private String addressLine3;
private String city;
private String companyName;
private String countryCode;
private String danishIdentityNumber;
private String email;
private String familyName;
private String givenName;
private String locale;
private Map metadata;
private String postalCode;
private String region;
private String swedishIdentityNumber;
/**
* The first line of the customer's address.
*/
public String getAddressLine1() {
return addressLine1;
}
/**
* The second line of the customer's address.
*/
public String getAddressLine2() {
return addressLine2;
}
/**
* The third line of the customer's address.
*/
public String getAddressLine3() {
return addressLine3;
}
/**
* The city of the customer's address.
*/
public String getCity() {
return 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").
*/
public String getCompanyName() {
return companyName;
}
/**
* [ISO 3166-1 alpha-2
* code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
*/
public String getCountryCode() {
return countryCode;
}
/**
* For Danish customers only. The civic/company number (CPR or CVR) of the customer. Must be
* supplied if the customer's bank account is denominated in Danish krone (DKK).
*/
public String getDanishIdentityNumber() {
return danishIdentityNumber;
}
/**
* Customer's email address. Required in most cases, as this allows GoCardless to send
* notifications to this customer.
*/
public String getEmail() {
return email;
}
/**
* 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.
*/
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.
*
*/
public String getLocale() {
return locale;
}
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
* characters and values up to 500 characters.
*/
public Map getMetadata() {
return metadata;
}
/**
* The customer's postal code.
*/
public String getPostalCode() {
return 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).
*/
public String getRegion() {
return region;
}
/**
* For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or
* organisationsnummer) of the customer. Must be supplied if the customer's bank account is
* denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
*/
public String getSwedishIdentityNumber() {
return swedishIdentityNumber;
}
}
public static class IncompleteField {
private IncompleteField() {
// blank to prevent instantiation
}
private String field;
private String message;
private String requestPointer;
/**
* The root resource.
*/
public String getField() {
return field;
}
/**
* A localised error message
*/
public String getMessage() {
return message;
}
/**
* The path to the field e.g. "/payer_authorisations/customer/city"
*/
public String getRequestPointer() {
return requestPointer;
}
}
/**
* Represents a link resource returned from the API.
*
* IDs of the created resources. Available after the Payer Authorisation is completed.
*/
public static class Links {
private Links() {
// blank to prevent instantiation
}
private String bankAccount;
private String customer;
private String mandate;
/**
* Unique identifier, beginning with "BA".
*/
public String getBankAccount() {
return bankAccount;
}
/**
* Unique identifier, beginning with "CU".
*/
public String getCustomer() {
return customer;
}
/**
* Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates
* created before 2016.
*/
public String getMandate() {
return mandate;
}
}
/**
* Represents a mandate resource returned from the API.
*
* All details required for the creation of a [Mandate](#core-endpoints-mandates).
*/
public static class Mandate {
private Mandate() {
// blank to prevent instantiation
}
private Map metadata;
private String payerIpAddress;
private String reference;
private Scheme scheme;
/**
* Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
* characters and values up to 500 characters.
*/
public Map getMetadata() {
return metadata;
}
/**
* For ACH customers only. Required for ACH customers. A string containing the IP address of
* 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.
*
*/
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.
*/
public String getReference() {
return reference;
}
/**
* A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", "becs_nz",
* "betalingsservice", "faster_payments", "pad", "pay_to" and "sepa_core" are supported.
*/
public Scheme getScheme() {
return scheme;
}
public enum Scheme {
@SerializedName("ach")
ACH, @SerializedName("autogiro")
AUTOGIRO, @SerializedName("bacs")
BACS, @SerializedName("becs")
BECS, @SerializedName("becs_nz")
BECS_NZ, @SerializedName("betalingsservice")
BETALINGSSERVICE, @SerializedName("faster_payments")
FASTER_PAYMENTS, @SerializedName("pad")
PAD, @SerializedName("pay_to")
PAY_TO, @SerializedName("sepa_core")
SEPA_CORE, @SerializedName("unknown")
UNKNOWN
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy