public class Customer
extends java.lang.Object
Represents a customer resource returned from the API.
Customer objects hold the contact details for a customer. A customer can have several customer bank accounts, which in turn can have several Direct Debit mandates.
Notes: - the swedish_identity_number field may only be supplied for Swedish customers, and must be supplied if you intend to set up an Autogiro mandate with the customer. - the danish_identity_number field may only be supplied for Danish customers, and must be supplied if you intend to set up a Betalingsservice mandate with the customer.
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAddressLine1()
The first line of the customer’s address.
|
java.lang.String |
getAddressLine2()
The second line of the customer’s address.
|
java.lang.String |
getAddressLine3()
The third line of the customer’s address.
|
java.lang.String |
getCity()
The city of the customer’s address.
|
java.lang.String |
getCompanyName()
Customer’s company name.
|
java.lang.String |
getCountryCode()
ISO 3166-1 alpha-2 code.
|
java.lang.String |
getCreatedAt()
Fixed timestamp, recording when this resource was created.
|
java.lang.String |
getDanishIdentityNumber()
For Danish customers only.
|
java.lang.String |
getEmail()
Customer’s email address.
|
java.lang.String |
getFamilyName()
Customer’s surname.
|
java.lang.String |
getGivenName()
Customer’s first name.
|
java.lang.String |
getId()
Unique identifier, beginning with “CU”.
|
java.lang.String |
getLanguage()
ISO 639-1 code.
|
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Key-value store of custom data.
|
java.lang.String |
getPostalCode()
The customer’s postal code.
|
java.lang.String |
getRegion()
The customer’s address region, county or department.
|
java.lang.String |
getSwedishIdentityNumber()
For Swedish customers only.
|
public java.lang.String getAddressLine1()
The first line of the customer’s address.
public java.lang.String getAddressLine2()
The second line of the customer’s address.
public java.lang.String getAddressLine3()
The third line of the customer’s address.
public java.lang.String getCity()
The city of the customer’s address.
public java.lang.String getCompanyName()
Customer’s company name. Required unless a given_name and family_name are provided.
public java.lang.String getCountryCode()
ISO 3166-1 alpha-2 code.
public java.lang.String getCreatedAt()
Fixed timestamp, recording when this resource was created.
public java.lang.String getDanishIdentityNumber()
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 java.lang.String getEmail()
Customer’s email address. Required in most cases, as this allows GoCardless to send notifications to this customer.
public java.lang.String getFamilyName()
Customer’s surname. Required unless a company_name is provided.
public java.lang.String getGivenName()
Customer’s first name. Required unless a company_name is provided.
public java.lang.String getId()
Unique identifier, beginning with “CU”.
public java.lang.String getLanguage()
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 java.util.Map<java.lang.String,java.lang.String> getMetadata()
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 java.lang.String getPostalCode()
The customer’s postal code.
public java.lang.String getRegion()
The customer’s address region, county or department.
public java.lang.String getSwedishIdentityNumber()
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.