Customer

Type:  
Abstract:  no
Status:  Active
Java Class:  Customer
Represents information about the customer.
Available Fields:
id
References: Customer Account.Id
XML Representation: attribute
Attributes: ReadOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request.
  • exists System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system upon successful customer creation.
  • echo System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system upon successful customer creation.
    • code
    References: Customer.Reference Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    Secondary identifier, which can be used to cross-reference records between UniPay and integrated systems.

    See Reference field type for additional information.

    **create Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system.\n\r\n> **Note:** Default: `object's id` which is returned in the response.\n\r\n> **Tip:** Providing consistent external identifiers improves integration capabilities.
  • exists Optional secondary identifier provided in the request.\n\r\n> **Note:** If not specified in the request, defaults to the same value as the object's id. Useful for cross-referencing with your system.\n\r\n> **Tip:** Providing consistent external identifiers improves integration capabilities.
  • echo Optional secondary identifier provided in the request.\n\r\n> **Note:** If not specified in the request, defaults to the same value as the object's id. Useful for cross-referencing with your system.\n\r\n> **Tip:** Providing consistent external identifiers improves integration capabilities.
    • accountId
    References: Customer.Merchant Account Code
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
    The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.


    **create Specifies which merchant account to use with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** When working with multiple merchant accounts, use this field to ensure transactions are processed against the correct account.
  • exists Indicates the merchant account used to create the customer.\n\r\n> **Note:** Identifies the merchant account under which this customer was created.
  • echo Indicates the merchant account used to create the customer.\n\r\n> **Note:** Identifies the merchant account under which this customer was created.
    • email
    References: Email Address.Email
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: EMAIL
    Customer's email address.

    **create Email associated with the customer.\n\r\n> **Tip:** Providing an email address enables automatic notifications and improves customer communication capabilities.
  • exists Email associated with the customer.\n\r\n> **Tip:** This email can be used for customer communications and notifications.
  • echo Email associated with the customer.\n\r\n> **Tip:** This email can be used for customer communications and notifications.
    • createDate
    References: Customer.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create Date when the customer was created.\n\r\n> **Note:** Automatically generated by the system. Format: yyyy-MM-dd HH:mm:ss. This field must not be provided in your request.
  • exists Date when the customer was created.\n\r\n> **Note:** Format: yyyy-MM-dd HH:mm:ss. Automatically generated by the system.
  • echo Date when the customer was created.\n\r\n> **Note:** Format: yyyy-MM-dd HH:mm:ss. Automatically generated by the system.
    • balance
    Type: Integer(11)
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create Balance of the customer in cents.\n\r\n> **Note:** Specify the amount in cents rather than dollars (e.g., $5.00 = 500).
  • exists Balance of the customer in cents.\n\r\n> **Note:** Amount is specified in cents rather than dollars (e.g., $5.00 = 500).
  • echo Balance of the customer in cents.\n\r\n> **Note:** Amount is specified in cents rather than dollars (e.g., $5.00 = 500).
    • isActive
    References: Customer Account.Is Active
    XML Representation: attribute
    Attributes:
    Default Value true
    Indicates whether the record is active in the system.

    **create Indicates whether a record is active within the system.\n\r\n> **Note:** Default: `true` (1). Possible values: `true` = active, `false` = inactive.
  • exists Indicates whether the customer record is active within the system.\n\r\n> **Note:** Possible values: `true` (1) = active, `false` (0) = inactive. Default: `true`.
  • echo Indicates whether the customer record is active within the system.\n\r\n> **Note:** Possible values: `true` (1) = active, `false` (0) = inactive. Default: `true`.
    • holderName
    References: Customer.Holder Name
    XML Representation: attribute
    Attributes: ReadOnly, Calculated
    Default Value
    Name of a payment card or bank account holder. The value is a concatenation of the firstName and lastName field values separated by a space.


    **create Calculated field that combines the firstName and lastName parameters.\n\r\n> **Note:** Automatically generated by combining the first name and last name, separated by a space. This field must not be provided in your request.
  • exists Calculated field that combines the firstName and lastName.\n\r\n> **Note:** Automatically generated by combining the first name and last name, separated by a space. This field is computed by the system and cannot be modified manually.\n\r\n> **Tip:** Use webhooks to track changes to compound fields like this one.
  • echo Calculated field that combines the firstName and lastName.\n\r\n> **Note:** Automatically generated by combining the first name and last name, separated by a space. This field is computed by the system and cannot be modified manually.\n\r\n> **Tip:** Use webhooks to track changes to compound fields like this one.
    • address
    References: Address.Address
    XML Representation: attribute
    Attributes: ReadOnly, Calculated
    Default Value
    Address associated with a payment card or bank account holder. The value is a concatenation of the street1, street2, city, state, zipCode, countryCode field values separated by commas (,).


    **create Calculated field containing the complete address.\n\r\n> **Note:** Automatically generated by concatenating the `street1`, `street2`, `city`, `state`, `zipCode`, and `countryCode` fields. This field must not be provided in your request.
  • exists Complete customer address as a single string.\n\r\n> **Note:** Automatically generated by concatenating the `street1`, `street2`, `city`, `state`, `zipCode`, and `countryCode` fields. This field is computed by the system and cannot be modified manually.
  • echo Complete customer address as a single string.\n\r\n> **Note:** Automatically generated by concatenating the `street1`, `street2`, `city`, `state`, `zipCode`, and `countryCode` fields. This field is computed by the system and cannot be modified manually.
    • firstName
    References: Customer.First Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    First name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the first name of the company's contact person.

    **create First name of the customer. This field applies to both individual and organization-type customers.\n\r\n> **Note:** For organizations, this field is used for the first name of the company's contact person.
  • exists First name of the customer.\n\r\n> **Note:** For organizations, this field contains the first name of the company's contact person.
  • echo First name of the customer.\n\r\n> **Note:** For organizations, this field contains the first name of the company's contact person.
    • lastName
    References: Customer.Last Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    Last name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the last name of the company's contact person.

    **create Last name of the customer. This field applies to both individual and organization-type customers.\n\r\n> **Note:** For organizations, this field is used for the last name of the company's contact person.
  • exists Last name of the customer.\n\r\n> **Note:** For organizations, this field contains the last name of the company's contact person.
  • echo Last name of the customer.\n\r\n> **Note:** For organizations, this field contains the last name of the company's contact person.
    • phone
    Type: String(15)
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NUMERIC
  • create Phone number of the customer.\n\r\n> **Note:** Include country code for international numbers.
  • exists Phone number of the customer.\n\r\n> **Note:** May include country code for international numbers.
  • echo Phone number of the customer.\n\r\n> **Note:** May include country code for international numbers.
    • organizationName
    References: Customer.Organization Name
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: NAME_BUSINESS
    Name of the organization associated with a customer.


    **create Name of the organization associated with the customer.\n\r\n> **Note:** This is a user-provided freeform field and does not represent any other data structure or object.
  • exists Name of the organization associated with the customer.\n\r\n> **Note:** This is a user-provided freeform field and does not represent any other data structure or object.
  • echo Name of the organization associated with the customer.\n\r\n> **Note:** This is a user-provided freeform field and does not represent any other data structure or object.
    • street1
    References: Address.Street 1
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street address of the customer.

    **create Street address of the customer (line 1).\n\r\n> **Tip:** Providing accurate address information improves fraud prevention capabilities and may affect transaction approval rates.
  • exists Street address of the customer (line 1).
  • echo Street address of the customer (line 1).
    • street2
    References: Address.Street 2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street address of the customer.

    **create Street address of the customer (line 2).\n\r\n> **Note:** Additional address details such as an apartment or suite number.
  • exists Street address of the customer (line 2).\n\r\n> **Note:** Contains additional address details such as an apartment or suite number.
  • echo Street address of the customer (line 2).\n\r\n> **Note:** Contains additional address details such as an apartment or suite number.
    • city
    References: Address.City
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City of the customer.

    **create The city of the customer.\n\r\n> **Tip:** Including complete address information may lower interchange costs for certain transaction types.
  • exists The city of the customer.
  • echo The city of the customer.
    • state
    References: Address.State
    XML Representation: attribute
    Attributes:
    Default Value
    State of the customer.

    **create The state of the customer.\n\r\n> **Note:** State format is subject to the associated country code. For US addresses, use two-letter state codes.
  • exists The state of the customer.\n\r\n> **Note:** Format is subject to the associated country code. For US addresses, uses two-letter state codes.
  • echo The state of the customer.\n\r\n> **Note:** Format is subject to the associated country code. For US addresses, uses two-letter state codes.
    • zipCode
    References: Address.ZIP Code
    XML Representation: attribute
    Attributes:
    Default Value
    ZIP or postal code of the customer.

    **create The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code in the Customer object.
  • exists The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code.
  • echo The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code.
    • countryCode
    References: Address.Country Code
    XML Representation: attribute
    Attributes:
    Default Value US
    Pattern: ALPHA
    Country code of the customer's address.

    **create The country code of the customer's address.\n\r\n> **Note:** Use ISO 3166-1 alpha-2 standard. Example: US for United States, CA for Canada.
  • exists The country code of the customer's address.\n\r\n> **Note:** Uses ISO 3166-1 alpha-2 standard. Example: US for United States, CA for Canada.
  • echo The country code of the customer's address.\n\r\n> **Note:** Uses ISO 3166-1 alpha-2 standard. Example: US for United States, CA for Canada.

    • XML Sample:

    <customer accountId=""  firstName="John Smith"  lastName="John Smith"  phone=""  organizationName="UnitedThinkers" />
    "<customer accountId=\"\" firstName=\"John Smith\" lastName=\"John Smith\" phone=\"\" organizationName=\"UnitedThinkers\" />"

    JSON Sample:

    {
  "accountId": "",
  "firstName": "John Smith",
  "lastName": "John Smith",
  "phone": "",
  "organizationName": "UnitedThinkers"
}

    XURL Sample:

    ?accountId=&firstName=John+Smith&lastName=John+Smith&phone=&organizationName=UnitedThinkers&
    accountId=
    firstName=John Smith
    lastName=John Smith
    phone=
    organizationName=UnitedThinkers
    Copyright © United Thinkers. (UniPay - Payment Gateway Software)
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.