Model.Ptsv2paymentsOrderInformationBillTo Maven / Gradle / Ivy
/*
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package Model;
import java.util.Objects;
import java.util.Arrays;
import Model.Ptsv2paymentsOrderInformationBillToCompany;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
/**
* Ptsv2paymentsOrderInformationBillTo
*/
public class Ptsv2paymentsOrderInformationBillTo {
@SerializedName("firstName")
private String firstName = null;
@SerializedName("lastName")
private String lastName = null;
@SerializedName("middleName")
private String middleName = null;
@SerializedName("nameSuffix")
private String nameSuffix = null;
@SerializedName("title")
private String title = null;
@SerializedName("company")
private Ptsv2paymentsOrderInformationBillToCompany company = null;
@SerializedName("address1")
private String address1 = null;
@SerializedName("address2")
private String address2 = null;
@SerializedName("address3")
private String address3 = null;
@SerializedName("address4")
private String address4 = null;
@SerializedName("locality")
private String locality = null;
@SerializedName("administrativeArea")
private String administrativeArea = null;
@SerializedName("postalCode")
private String postalCode = null;
@SerializedName("county")
private String county = null;
@SerializedName("country")
private String country = null;
@SerializedName("district")
private String district = null;
@SerializedName("buildingNumber")
private String buildingNumber = null;
@SerializedName("email")
private String email = null;
@SerializedName("emailDomain")
private String emailDomain = null;
@SerializedName("phoneNumber")
private String phoneNumber = null;
@SerializedName("phoneType")
private String phoneType = null;
@SerializedName("verificationStatus")
private String verificationStatus = null;
@SerializedName("alternatePhoneNumber")
private String alternatePhoneNumber = null;
@SerializedName("alternateEmail")
private String alternateEmail = null;
public Ptsv2paymentsOrderInformationBillTo firstName(String firstName) {
this.firstName = firstName;
return this;
}
/**
* Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return firstName
**/
@ApiModelProperty(value = "Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public Ptsv2paymentsOrderInformationBillTo lastName(String lastName) {
this.lastName = lastName;
return this;
}
/**
* Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return lastName
**/
@ApiModelProperty(value = "Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Ptsv2paymentsOrderInformationBillTo middleName(String middleName) {
this.middleName = middleName;
return this;
}
/**
* Customer's middle name.
* @return middleName
**/
@ApiModelProperty(value = "Customer's middle name. ")
public String getMiddleName() {
return middleName;
}
public void setMiddleName(String middleName) {
this.middleName = middleName;
}
public Ptsv2paymentsOrderInformationBillTo nameSuffix(String nameSuffix) {
this.nameSuffix = nameSuffix;
return this;
}
/**
* Customer's name suffix.
* @return nameSuffix
**/
@ApiModelProperty(value = "Customer's name suffix. ")
public String getNameSuffix() {
return nameSuffix;
}
public void setNameSuffix(String nameSuffix) {
this.nameSuffix = nameSuffix;
}
public Ptsv2paymentsOrderInformationBillTo title(String title) {
this.title = title;
return this;
}
/**
* Title.
* @return title
**/
@ApiModelProperty(value = "Title. ")
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public Ptsv2paymentsOrderInformationBillTo company(Ptsv2paymentsOrderInformationBillToCompany company) {
this.company = company;
return this;
}
/**
* Get company
* @return company
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationBillToCompany getCompany() {
return company;
}
public void setCompany(Ptsv2paymentsOrderInformationBillToCompany company) {
this.company = company;
}
public Ptsv2paymentsOrderInformationBillTo address1(String address1) {
this.address1 = address1;
return this;
}
/**
* Payment card billing street address as it appears on the credit card issuer's records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
* @return address1
**/
@ApiModelProperty(value = "Payment card billing street address as it appears on the credit card issuer's records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ")
public String getAddress1() {
return address1;
}
public void setAddress1(String address1) {
this.address1 = address1;
}
public Ptsv2paymentsOrderInformationBillTo address2(String address2) {
this.address2 = address2;
return this;
}
/**
* Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)
* @return address2
**/
@ApiModelProperty(value = "Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) ")
public String getAddress2() {
return address2;
}
public void setAddress2(String address2) {
this.address2 = address2;
}
public Ptsv2paymentsOrderInformationBillTo address3(String address3) {
this.address3 = address3;
return this;
}
/**
* Additional address information (third line of the billing address)
* @return address3
**/
@ApiModelProperty(value = "Additional address information (third line of the billing address) ")
public String getAddress3() {
return address3;
}
public void setAddress3(String address3) {
this.address3 = address3;
}
public Ptsv2paymentsOrderInformationBillTo address4(String address4) {
this.address4 = address4;
return this;
}
/**
* Additional address information (fourth line of the billing address)
* @return address4
**/
@ApiModelProperty(value = "Additional address information (fourth line of the billing address) ")
public String getAddress4() {
return address4;
}
public void setAddress4(String address4) {
this.address4 = address4;
}
public Ptsv2paymentsOrderInformationBillTo locality(String locality) {
this.locality = locality;
return this;
}
/**
* Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return locality
**/
@ApiModelProperty(value = "Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getLocality() {
return locality;
}
public void setLocality(String locality) {
this.locality = locality;
}
public Ptsv2paymentsOrderInformationBillTo administrativeArea(String administrativeArea) {
this.administrativeArea = administrativeArea;
return this;
}
/**
* State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return administrativeArea
**/
@ApiModelProperty(value = "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getAdministrativeArea() {
return administrativeArea;
}
public void setAdministrativeArea(String administrativeArea) {
this.administrativeArea = administrativeArea;
}
public Ptsv2paymentsOrderInformationBillTo postalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/**
* Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field.
* @return postalCode
**/
@ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. ")
public String getPostalCode() {
return postalCode;
}
public void setPostalCode(String postalCode) {
this.postalCode = postalCode;
}
public Ptsv2paymentsOrderInformationBillTo county(String county) {
this.county = county;
return this;
}
/**
* U.S. county if available.
* @return county
**/
@ApiModelProperty(value = "U.S. county if available.")
public String getCounty() {
return county;
}
public void setCounty(String county) {
this.county = county;
}
public Ptsv2paymentsOrderInformationBillTo country(String country) {
this.country = country;
return this;
}
/**
* Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return country
**/
@ApiModelProperty(value = "Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getCountry() {
return country;
}
public void setCountry(String country) {
this.country = country;
}
public Ptsv2paymentsOrderInformationBillTo district(String district) {
this.district = district;
return this;
}
/**
* Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**.
* @return district
**/
@ApiModelProperty(value = "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. ")
public String getDistrict() {
return district;
}
public void setDistrict(String district) {
this.district = district;
}
public Ptsv2paymentsOrderInformationBillTo buildingNumber(String buildingNumber) {
this.buildingNumber = buildingNumber;
return this;
}
/**
* Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing.
* @return buildingNumber
**/
@ApiModelProperty(value = "Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing. ")
public String getBuildingNumber() {
return buildingNumber;
}
public void setBuildingNumber(String buildingNumber) {
this.buildingNumber = buildingNumber;
}
public Ptsv2paymentsOrderInformationBillTo email(String email) {
this.email = email;
return this;
}
/**
* Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return email
**/
@ApiModelProperty(value = "Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Ptsv2paymentsOrderInformationBillTo emailDomain(String emailDomain) {
this.emailDomain = emailDomain;
return this;
}
/**
* Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address.
* @return emailDomain
**/
@ApiModelProperty(value = "Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. ")
public String getEmailDomain() {
return emailDomain;
}
public void setEmailDomain(String emailDomain) {
this.emailDomain = emailDomain;
}
public Ptsv2paymentsOrderInformationBillTo phoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
return this;
}
/**
* Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.
* @return phoneNumber
**/
@ApiModelProperty(value = "Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. ")
public String getPhoneNumber() {
return phoneNumber;
}
public void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
public Ptsv2paymentsOrderInformationBillTo phoneType(String phoneType) {
this.phoneType = phoneType;
return this;
}
/**
* Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work
* @return phoneType
**/
@ApiModelProperty(value = "Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work ")
public String getPhoneType() {
return phoneType;
}
public void setPhoneType(String phoneType) {
this.phoneType = phoneType;
}
public Ptsv2paymentsOrderInformationBillTo verificationStatus(String verificationStatus) {
this.verificationStatus = verificationStatus;
return this;
}
/**
* Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED
* @return verificationStatus
**/
@ApiModelProperty(value = "Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED ")
public String getVerificationStatus() {
return verificationStatus;
}
public void setVerificationStatus(String verificationStatus) {
this.verificationStatus = verificationStatus;
}
public Ptsv2paymentsOrderInformationBillTo alternatePhoneNumber(String alternatePhoneNumber) {
this.alternatePhoneNumber = alternatePhoneNumber;
return this;
}
/**
* #### Visa Platform Connect contains customer's alternate phone number.
* @return alternatePhoneNumber
**/
@ApiModelProperty(value = "#### Visa Platform Connect contains customer's alternate phone number. ")
public String getAlternatePhoneNumber() {
return alternatePhoneNumber;
}
public void setAlternatePhoneNumber(String alternatePhoneNumber) {
this.alternatePhoneNumber = alternatePhoneNumber;
}
public Ptsv2paymentsOrderInformationBillTo alternateEmail(String alternateEmail) {
this.alternateEmail = alternateEmail;
return this;
}
/**
* #### Visa Platform Connect contains customer's alternate email address.
* @return alternateEmail
**/
@ApiModelProperty(value = "#### Visa Platform Connect contains customer's alternate email address. ")
public String getAlternateEmail() {
return alternateEmail;
}
public void setAlternateEmail(String alternateEmail) {
this.alternateEmail = alternateEmail;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Ptsv2paymentsOrderInformationBillTo ptsv2paymentsOrderInformationBillTo = (Ptsv2paymentsOrderInformationBillTo) o;
return Objects.equals(this.firstName, ptsv2paymentsOrderInformationBillTo.firstName) &&
Objects.equals(this.lastName, ptsv2paymentsOrderInformationBillTo.lastName) &&
Objects.equals(this.middleName, ptsv2paymentsOrderInformationBillTo.middleName) &&
Objects.equals(this.nameSuffix, ptsv2paymentsOrderInformationBillTo.nameSuffix) &&
Objects.equals(this.title, ptsv2paymentsOrderInformationBillTo.title) &&
Objects.equals(this.company, ptsv2paymentsOrderInformationBillTo.company) &&
Objects.equals(this.address1, ptsv2paymentsOrderInformationBillTo.address1) &&
Objects.equals(this.address2, ptsv2paymentsOrderInformationBillTo.address2) &&
Objects.equals(this.address3, ptsv2paymentsOrderInformationBillTo.address3) &&
Objects.equals(this.address4, ptsv2paymentsOrderInformationBillTo.address4) &&
Objects.equals(this.locality, ptsv2paymentsOrderInformationBillTo.locality) &&
Objects.equals(this.administrativeArea, ptsv2paymentsOrderInformationBillTo.administrativeArea) &&
Objects.equals(this.postalCode, ptsv2paymentsOrderInformationBillTo.postalCode) &&
Objects.equals(this.county, ptsv2paymentsOrderInformationBillTo.county) &&
Objects.equals(this.country, ptsv2paymentsOrderInformationBillTo.country) &&
Objects.equals(this.district, ptsv2paymentsOrderInformationBillTo.district) &&
Objects.equals(this.buildingNumber, ptsv2paymentsOrderInformationBillTo.buildingNumber) &&
Objects.equals(this.email, ptsv2paymentsOrderInformationBillTo.email) &&
Objects.equals(this.emailDomain, ptsv2paymentsOrderInformationBillTo.emailDomain) &&
Objects.equals(this.phoneNumber, ptsv2paymentsOrderInformationBillTo.phoneNumber) &&
Objects.equals(this.phoneType, ptsv2paymentsOrderInformationBillTo.phoneType) &&
Objects.equals(this.verificationStatus, ptsv2paymentsOrderInformationBillTo.verificationStatus) &&
Objects.equals(this.alternatePhoneNumber, ptsv2paymentsOrderInformationBillTo.alternatePhoneNumber) &&
Objects.equals(this.alternateEmail, ptsv2paymentsOrderInformationBillTo.alternateEmail);
}
@Override
public int hashCode() {
return Objects.hash(firstName, lastName, middleName, nameSuffix, title, company, address1, address2, address3, address4, locality, administrativeArea, postalCode, county, country, district, buildingNumber, email, emailDomain, phoneNumber, phoneType, verificationStatus, alternatePhoneNumber, alternateEmail);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Ptsv2paymentsOrderInformationBillTo {\n");
if (firstName != null) sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n");
if (lastName != null) sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n");
if (middleName != null) sb.append(" middleName: ").append(toIndentedString(middleName)).append("\n");
if (nameSuffix != null) sb.append(" nameSuffix: ").append(toIndentedString(nameSuffix)).append("\n");
if (title != null) sb.append(" title: ").append(toIndentedString(title)).append("\n");
if (company != null) sb.append(" company: ").append(toIndentedString(company)).append("\n");
if (address1 != null) sb.append(" address1: ").append(toIndentedString(address1)).append("\n");
if (address2 != null) sb.append(" address2: ").append(toIndentedString(address2)).append("\n");
if (address3 != null) sb.append(" address3: ").append(toIndentedString(address3)).append("\n");
if (address4 != null) sb.append(" address4: ").append(toIndentedString(address4)).append("\n");
if (locality != null) sb.append(" locality: ").append(toIndentedString(locality)).append("\n");
if (administrativeArea != null) sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n");
if (postalCode != null) sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n");
if (county != null) sb.append(" county: ").append(toIndentedString(county)).append("\n");
if (country != null) sb.append(" country: ").append(toIndentedString(country)).append("\n");
if (district != null) sb.append(" district: ").append(toIndentedString(district)).append("\n");
if (buildingNumber != null) sb.append(" buildingNumber: ").append(toIndentedString(buildingNumber)).append("\n");
if (email != null) sb.append(" email: ").append(toIndentedString(email)).append("\n");
if (emailDomain != null) sb.append(" emailDomain: ").append(toIndentedString(emailDomain)).append("\n");
if (phoneNumber != null) sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n");
if (phoneType != null) sb.append(" phoneType: ").append(toIndentedString(phoneType)).append("\n");
if (verificationStatus != null) sb.append(" verificationStatus: ").append(toIndentedString(verificationStatus)).append("\n");
if (alternatePhoneNumber != null) sb.append(" alternatePhoneNumber: ").append(toIndentedString(alternatePhoneNumber)).append("\n");
if (alternateEmail != null) sb.append(" alternateEmail: ").append(toIndentedString(alternateEmail)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
// return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy