java.lang.Object
- com.adyen.model.checkout.BillingAddress

public class BillingAddress
extends Object

BillingAddress

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CITY`
`static String`	`JSON_PROPERTY_COUNTRY`
`static String`	`JSON_PROPERTY_HOUSE_NUMBER_OR_NAME`
`static String`	`JSON_PROPERTY_POSTAL_CODE`
`static String`	`JSON_PROPERTY_STATE_OR_PROVINCE`
`static String`	`JSON_PROPERTY_STREET`

Constructor Summary

Constructors
Constructor Description

BillingAddress()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BillingAddress`	`city(String city)`	The name of the city.
`BillingAddress`	`country(String country)`	The two-character ISO-3166-1 alpha-2 country code.
`boolean`	`equals(Object o)`	Return true if this BillingAddress object is equal to o.
`static BillingAddress`	`fromJson(String jsonString)`	Create an instance of BillingAddress given an JSON string
`String`	`getCity()`	The name of the city.
`String`	`getCountry()`	The two-character ISO-3166-1 alpha-2 country code.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getHouseNumberOrName()`	The number or name of the house.
`String`	`getPostalCode()`	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`String`	`getStateOrProvince()`	The two-character ISO 3166-2 state or province code.
`String`	`getStreet()`	The name of the street.
`int`	`hashCode()`
`BillingAddress`	`houseNumberOrName(String houseNumberOrName)`	The number or name of the house.
`BillingAddress`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`BillingAddress`	`postalCode(String postalCode)`	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`void`	`setCity(String city)`	The name of the city.
`void`	`setCountry(String country)`	The two-character ISO-3166-1 alpha-2 country code.
`void`	`setHouseNumberOrName(String houseNumberOrName)`	The number or name of the house.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setPostalCode(String postalCode)`	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`void`	`setStateOrProvince(String stateOrProvince)`	The two-character ISO 3166-2 state or province code.
`void`	`setStreet(String street)`	The name of the street.
`BillingAddress`	`stateOrProvince(String stateOrProvince)`	The two-character ISO 3166-2 state or province code.
`BillingAddress`	`street(String street)`	The name of the street.
`String`	`toJson()`	Convert an instance of BillingAddress to an JSON string
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_CITY
```
public static final String JSON_PROPERTY_CITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COUNTRY
```
public static final String JSON_PROPERTY_COUNTRY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HOUSE_NUMBER_OR_NAME
```
public static final String JSON_PROPERTY_HOUSE_NUMBER_OR_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POSTAL_CODE
```
public static final String JSON_PROPERTY_POSTAL_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STATE_OR_PROVINCE
```
public static final String JSON_PROPERTY_STATE_OR_PROVINCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STREET
```
public static final String JSON_PROPERTY_STREET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BillingAddress
```
public BillingAddress()
```
- Method Detail
  - city
```
public BillingAddress city(String city)
```
    The name of the city. Maximum length: 3000 characters.
    
    Parameters:
    
    city - The name of the city. Maximum length: 3000 characters.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getCity
```
public String getCity()
```
    The name of the city. Maximum length: 3000 characters.
    
    Returns:
    
    city The name of the city. Maximum length: 3000 characters.
  - setCity
```
public void setCity(String city)
```
    The name of the city. Maximum length: 3000 characters.
    
    Parameters:
    
    city - The name of the city. Maximum length: 3000 characters.
  - country
```
public BillingAddress country(String country)
```
    The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    
    Parameters:
    
    country - The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getCountry
```
public String getCountry()
```
    The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    
    Returns:
    
    country The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
  - setCountry
```
public void setCountry(String country)
```
    The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    
    Parameters:
    
    country - The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
  - houseNumberOrName
```
public BillingAddress houseNumberOrName(String houseNumberOrName)
```
    The number or name of the house. Maximum length: 3000 characters.
    
    Parameters:
    
    houseNumberOrName - The number or name of the house. Maximum length: 3000 characters.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getHouseNumberOrName
```
public String getHouseNumberOrName()
```
    The number or name of the house. Maximum length: 3000 characters.
    
    Returns:
    
    houseNumberOrName The number or name of the house. Maximum length: 3000 characters.
  - setHouseNumberOrName
```
public void setHouseNumberOrName(String houseNumberOrName)
```
    The number or name of the house. Maximum length: 3000 characters.
    
    Parameters:
    
    houseNumberOrName - The number or name of the house. Maximum length: 3000 characters.
  - postalCode
```
public BillingAddress postalCode(String postalCode)
```
    A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    
    Parameters:
    
    postalCode - A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getPostalCode
```
public String getPostalCode()
```
    A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    
    Returns:
    
    postalCode A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    
    Parameters:
    
    postalCode - A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
  - stateOrProvince
```
public BillingAddress stateOrProvince(String stateOrProvince)
```
    The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    
    Parameters:
    
    stateOrProvince - The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getStateOrProvince
```
public String getStateOrProvince()
```
    The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    
    Returns:
    
    stateOrProvince The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
  - setStateOrProvince
```
public void setStateOrProvince(String stateOrProvince)
```
    The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    
    Parameters:
    
    stateOrProvince - The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
  - street
```
public BillingAddress street(String street)
```
    The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    
    Parameters:
    
    street - The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    
    Returns:
    
    the current BillingAddress instance, allowing for method chaining
  - getStreet
```
public String getStreet()
```
    The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    
    Returns:
    
    street The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - setStreet
```
public void setStreet(String street)
```
    The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    
    Parameters:
    
    street - The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - includeNullValues
```
public BillingAddress includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this BillingAddress object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static BillingAddress fromJson(String jsonString)
                               throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of BillingAddress given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of BillingAddress
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BillingAddress
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of BillingAddress to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class BillingAddress

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_CITY

JSON_PROPERTY_COUNTRY

JSON_PROPERTY_HOUSE_NUMBER_OR_NAME

JSON_PROPERTY_POSTAL_CODE

JSON_PROPERTY_STATE_OR_PROVINCE

JSON_PROPERTY_STREET

Constructor Detail

BillingAddress

Method Detail

city

getCity

setCity

country

getCountry

setCountry

houseNumberOrName

getHouseNumberOrName

setHouseNumberOrName

postalCode

getPostalCode

setPostalCode

stateOrProvince

getStateOrProvince

setStateOrProvince

street

getStreet

setStreet

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson