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
Unique Customer ID generated by the system. <div class="info legacy"> For more information see term: Customer. </div>

  • exists
    • Unique Customer ID generated by the system. <div class="info legacy"> For more information see term: Customer. </div> <br/>

  • echo
    • Unique Customer ID used for filtering records.
    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 TidyPay and integrated systems.

    See Reference field type for additional information.

    **create
    Unique Customer ID supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • exists
    • Unique Customer ID supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • echo
    • Unique Customer ID supplied by external/user's system used for filtering unique Customer ID records.
    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 Merchant account associated with Customer.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br> <br> Your API credentials may be associated with more than one accountId.


  • exists
    • Merchant account associated with Customer.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br><br> Your API credentials may be associated with more than one accountId.
    <br>

  • echo
    • Reference to an account used for filtering records.
    email
    References: Email Address.Email
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: EMAIL
    Customer's email address.

    **create
    Email address of the Customer.

  • exists
    • Email address of the Customer.

  • echo
    • Email address of the Customer used for filtering Customer records.
    createDate
    References: Customer.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Date when the Customer was created.
    Note: Date format: yyyy-MM-dd HH:mm:ss.


  • exists
    • Date when the Customer was created.
    Note: Date format: yyyy-MM-dd HH:mm:ss.


  • echo
    • Date used for filtering Customer records.
    balance
    Type: Integer(11)
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Current balance of the Customer.
    Note: This value is in cents.


  • exists
    • Current balance of the Customer.
    Note: This value is in cents.


  • echo
    • Current balance of the Customer used for filtering Customer records.
    isActive
    References: Customer Account.Is Active
    XML Representation: attribute
    Attributes:
    Default Value true
    Indicates whether the record is active in the system.

    **create
    Status of the Customer.
    Note: Values: true (active) or false (inactive).


  • exists
    • Status of the Customer.
    Note: Values: true (active) or false (inactive).


  • echo
    • Status of a Customer used for filtering Customer records.
    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 Combined values of the firstName and lastName in the Customer.
    Note: This value is a concatenation of the firstName and lastName values provided at the time of Customer creation or modification.


  • exists
    • Combined values of the firstName and lastName in the Customer.
    Note: This value is a concatenation of the firstName and lastName values provided at the time of Customer creation or modification.


  • echo
    • Combined values of the firstName and lastName used for filtering Customer records.
    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 Combined address field of the Customer.
    Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values.


  • exists
    • Combined address field of the Customer.
    Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values.


  • echo
    • Mailing address of the Customer used for filtering Customer records.
    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.

  • exists
    • First name of the Customer.

  • echo
    • First name of the Customer used for filtering Customer records.
    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.

  • exists
    • Last name of the Customer.

  • echo
    • Last name of the Customer used for filtering Customer records.
    phone
    Type: String(15)
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NUMERIC
  • create
    • Phone number of the Customer.

  • exists
    • Phone number of the Customer.

  • echo
    • Phone number of the Customer used for filtering Customer records.
    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 associated organization for the Customer.
    Note: OrganizationName is a user provided freeform field and does not represent any other data structure or object.


  • exists
    • Name of the associated organization for the Customer.
    Note: OrganizationName is a user provided freeform field and does not represent any other data structure or object.


  • echo
    • Name of the organization used for filtering Customer records.
    street1
    References: Address.Street 1
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street address of the customer.

    **create Street address of the Customer.

  • exists
    • Street address of the Customer.

  • echo
    • Street address of the Customer used for filtering Customer records.
    street2
    References: Address.Street 2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street address of the customer.

    **create Secondary Street address of the Customer.
    Note: Additional street data such as appartment or suite number.


  • exists
    • Secondary Street address of the Customer.
    Note: Additional street data such as appartment or suite number.


  • echo
    • Street address of the Customer used for filtering Customer records.
    city
    References: Address.City
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City of the customer.

    **create City of the Customer.

  • exists
    • City of the Customer.

  • echo
    • City of the Customer used for filtering Customer records.
    state
    References: Address.State
    XML Representation: attribute
    Attributes:
    Default Value
    State of the customer.

    **create State of the Customer.
    Note: State value format is subject to the associated country code in the Customer object.


  • exists
    • State of the Customer.
    Note: State value format is subject to the associated country code in the Customer object.


  • echo
    • State code of the Customer used for filtering Customer records.
    zipCode
    References: Address.ZIP Code
    XML Representation: attribute
    Attributes:
    Default Value
    ZIP or postal code of the customer.

    **create ZIP/postal code of the Customer.
    Note: ZipCode value format is subject to the associated country code in the Customer object.


  • exists
    • ZIP/postal code of the Customer.
    Note: ZipCode value format is subject to the associated country code in the Customer object.


  • echo
    • ZIP/postal code of the Customer used for filtering Customer records.
    countryCode
    References: Address.Country Code
    XML Representation: attribute
    Attributes:
    Default Value US
    Pattern: ALPHA
    Country code of the customer's address.

    **create Country code of the Customer.

  • exists
    • Country code of the Customer.

  • echo
    • Country code of the Customer used for filtering Customer records.

    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 © TidyPay. All Rights Reserved.
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.