PaymentOption

Type:  
Abstract:  no
Status:  Active
Java Class:  PaymentOption
Payment option information associated with the merchant.
Available Fields:
id
References: Payment Option.Id
XML Representation: attribute
Attributes: ReadOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create
Unique PaymentOption ID generated by the system. <div class="info legacy"> For more information see term: Payment Option. </div>

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

  • echo
    • Unique PaymentOption ID used for filtering PaymentOption records.
    createDate
    References: Payment Option.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Date when the record was created.

    **create Date when the PaymentOption was created.
    Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.


  • exists
    • Date when the PaymentOption was created.
    Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.


  • echo
    • Date used for filtering PaymentOption records.
    code
    References: Payment Option.Reference Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    Secondary identifier that can be used to cross-reference records between TidyPay and integrated systems.

    See Reference Code definition for additional information.

    **create
    Unique PaymentOption 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 PaymentOption 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 PaymentOption ID supplied by external/user's system used for filtering unique Customer ID records.
    accountNumber
    References: Payment Option.Number
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Number of a payment card or bank account.

    **create Number of a payment card or bank account that will be used during the transaction processing.

  • exists
    • Number of a payment card or bank account.

  • echo
    • Number of a payment card or bank account used for filtering records.
    accountId
    References: Payment Option.Merchant Account Code
    XML Representation: attribute
    Attributes:
    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 PaymentOption.
    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 PaymentOption.
    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.


  • echo
    • Reference to an account used for filtering records.
    customerId
    Type: Long
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Identifier of a Customer that a PaymentOption will be associated with.

  • exists
    • Identifier of a Customer that a PaymentOption is associated with.

  • echo
    • Identifier of a Customer used as a search criteria to limit results.
    isActive
    References: Payment Option.Is Active
    XML Representation: attribute
    Attributes:
    Default Value true
    Indicates whether the record is active in the system.

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


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


  • echo
    • Status of the PaymentOption used for filtering PaymentOption records.
    holderName
    References: Payment Option.Holder Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    Name of the bank account or credit card holder.

    The value is a concatenation of the firstName and lastName field values separated by a space.
    address
    References: Payment Option.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 records.

    token
    References: Payment Option.Token
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
  • create
    • Unique random characters generated by the system for identifying and securely transmitting sensitive data.

  • exists
    • Unique random characters generated by the system for identifying and securely transmitting sensitive data.

  • echo
    • Unique random characters generated by the system used for filtering PaymentOption records.
    type
    References: Payment Option.Payment Option CL
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Reference to the entity that represents possible types of payment options.

    **create Type of a Payment Option that will be created.

  • exists
    • Type of a Payment Option.

  • echo
    • Type of a Payment Option used as a search criteria to limit results.
    accountAccessory
    References: Payment Option.Accessory
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NUMERIC
    Expiration date of the card or bank routing number.

    **create Card expiration date or bank routing number that will be used during the transaction processing.

  • exists
    • Card expiration date or bank routing number.

  • echo
    • Card expiration date or bank routing number used for filtering records.
    csc
    References: Payment Option.CVV2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: NUMERIC
    CVV2 code associated with payment.

    **create CVV2 security code of the credit card that will be used for the transaction processing.

  • exists
    • CVV2 security code of the credit card used for the transaction processing.

  • echo
    • CVV2 security code of the credit card used as a search criteria to limit results.
    tokenCode
    References: Payment Option.Token Code
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Code of the token associated with the particular payment option.

    **create Code of the token associated with the particular payment option.

  • exists
    • Code of the token associated with the particular payment option.

  • echo
    • Code of the token used for filtering PaymentOption records.
    street1
    References: Payment Option.Street1
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street name of the user's mailing address.

    **create Street address of the Customer.

  • exists
    • Street address of the Customer.

  • echo
    • Street address of the Customer object used for filtering PaymentOption records.
    street2
    References: Payment Option.Street2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Additional street name field for entering user's mailing address.

    **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
    • Secondary street address of the Customer used for filtering PaymentOption records.
    city
    References: Payment Option.City
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City name of the user's mailing address.

    **create City of the Customer.

  • exists
    • City of the Customer.

  • echo
    • City of the Customer used for filtering PaymentOption records.
    state
    References: Payment Option.State
    XML Representation: attribute
    Attributes:
    Default Value
    Code of the state associated with a user's mailing address.

    **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 of the Customer used for filtering PaymentOption records.
    zipCode
    References: Payment Option.ZIP Code
    XML Representation: attribute
    Attributes:
    Default Value
    ZIP or postal code associated with a user's mailing address.

    **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 PaymentOption records.
    countryCode
    References: Payment Option.Country CL
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: ALPHA
    Enumeration of possible country codes associated with a user's mailing address.

    **create Country code of the Customer.

  • exists
    • Country code of the Customer.

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

    XML Sample:

    <payment-option accountNumber=""  holderName=""  accountAccessory="" />
    "<payment-option accountNumber=\"\" holderName=\"\" accountAccessory=\"\" />"

    JSON Sample:

    {
  "accountNumber": "",
  "holderName": "",
  "accountAccessory": ""
}

    XURL Sample:

    ?accountNumber=&holderName=&accountAccessory=&
    accountNumber=
    holderName=
    accountAccessory=
    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.