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 The unique PaymentOption ID generated by the system.\n\r\n> **Note:** This is an auto-incremented integer value that serves as the primary identifier for the payment option.
  • exists The identifier of the object used for references; auto-incremented integer value.\n\r\n> **Note:** This is the primary system-generated identifier for the payment option.
  • echo The identifier of the object used for references; auto-incremented integer value.\n\r\n> **Note:** This is the primary system-generated identifier for the payment option.
    • createDate
    References: Payment Option.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Date when the record was created.

    **create The date when the payment option was created.\n\r\n> **Note:** In API request, submit in yyyy-MM-dd format. In API response, returns in yyyy-MM-dd HH:mm:ss format.
  • exists The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss.
  • echo The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss.
    • 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 UniPay and integrated systems.

    See Reference Code definition for additional information.

    **create The unique payment option ID supplied by the external/user's system.\n\r\n> **Note:** Optional secondary identifier. Typically a reference to an ID in your own system. If not provided, the system will use the object's id generated at creation time.
  • exists The optional secondary identifier supplied by the external/user's system.\n\r\n> **Note:** Typically a reference to an ID in your own system. By default, this value is set to the same as the object's id returned in the response.
  • echo The optional secondary identifier supplied by the external/user's system.\n\r\n> **Note:** Typically a reference to an ID in your own system. By default, this value is set to the same as the object's id returned in the response.
    • accountNumber
    References: Payment Option.Number
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Number of a payment card or bank account.

    **create The credit card or bank account number used during transaction processing. This field is required if you are not using a token for the transaction.\n\r\n> **Note:** Maximum length is 20 characters with no spaces or special characters.\n\r\n> **Attention:** This field contains sensitive cardholder data that will be replaced with a secure token after processing.
  • exists The credit card or bank account number.\n\r\n> **Note:** This field is typically masked in the response for security reasons, showing only the last 4 digits of the actual number.\n\r\n> **Attention:** This field contains sensitive payment information and should be handled securely.
  • echo The credit card or bank account number.\n\r\n> **Note:** This field is typically masked in the response for security reasons, showing only the last 4 digits of the actual number.\n\r\n> **Attention:** This field contains sensitive payment information and should be handled securely.
    • 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 The merchant account associated with the payment option.\n\r\n> **Note:** If your API user is associated with multiple merchant accounts, you can specify the merchant account ID to reduce the data set in API responses. Your credentials may be associated with more than one accountId.
  • exists The merchant account associated with this payment option.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.
  • echo The merchant account associated with this payment option.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.
    • customerId
    Type: Long
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create The identifier of a customer that the payment option will be associated with.\n\r\n> **Note:** This field establishes the relationship between the payment option and customer records in the system.
  • exists The ID of the customer in the system.\n\r\n> **Note:** This field establishes the relationship between the payment option and customer records.
  • echo The ID of the customer in the system.\n\r\n> **Note:** This field establishes the relationship between the payment option and customer records.
    • isActive
    References: Payment Option.Is Active
    XML Representation: attribute
    Attributes:
    Default Value true
    Indicates whether the record is active in the system.

    **create The status of the payment option.\n\r\n> **Note:** Possible values: true (active) or false (inactive). Default: `true`.
  • exists The status indicator that shows whether a record is active within the system.\n\r\n> **Note:** Possible values: true (1) or false (0). Default: `true` (1).
  • echo The status indicator that shows whether a record is active within the system.\n\r\n> **Note:** Possible values: true (1) or false (0). Default: `true` (1).
    • holderName
    References: Payment Option.Holder Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    Name of the bank account or credit card holder.

    **create The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters. This field is automatically populated based on customer information.
  • exists The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters.
  • echo The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters.
    • 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 The combined address field of the customer.\n\r\n> **Note:** This is a comma-separated concatenation of street1, street2, city, state, zipCode, and countryCode values.
  • exists The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters.
  • echo The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters.
    • token
    References: Payment Option.Token
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
  • create The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely.
  • exists The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely.
  • echo The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely.
    • 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 The type of payment option that will be created.
  • exists The type of the payment method.
  • echo The type of the payment method.
    • accountAccessory
    References: Payment Option.Accessory
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NUMERIC
    Expiration date of the card or bank routing number.

    **create The card expiration date (for credit cards) or routing number (for bank accounts) used during transaction processing. This field is required even when using a token.\n\r\n> **Note:** For payment cards, format as MMYY (e.g., '1225' for December 2025). For bank accounts, provide the routing number. Maximum length is 10 characters.
  • exists The card expiration date (for credit cards) or routing number (for bank accounts).\n\r\n> **Note:** For payment cards, format is MMYY (e.g., '1225' for December 2025). For bank accounts, this contains the routing number.
  • echo The card expiration date (for credit cards) or routing number (for bank accounts).\n\r\n> **Note:** For payment cards, format is MMYY (e.g., '1225' for December 2025). For bank accounts, this contains the routing number.
    • csc
    References: Payment Option.CVV2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: NUMERIC
    CVV2 code associated with payment.

    **create The card security code (three digits on the back of a payment card).\n\r\n> **Note:** Maximum length is 4 characters to accommodate American Express cards that have a 4-digit security code.
  • exists The card security code (three digits on the back of a payment card).\n\r\n> **Note:** This field is typically not returned in the response for security reasons.\n\r\n> **Attention:** This field contains sensitive security information.
  • echo The card security code (three digits on the back of a payment card).\n\r\n> **Note:** This field is typically not returned in the response for security reasons.\n\r\n> **Attention:** This field contains sensitive security information.
    • tokenCode
    References: Payment Option.Token Code
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Code of the token associated with the particular payment option.

    **create The code of the token associated with the payment option. This field is required if using a tokenized payment method instead of providing direct card or account details.\n\r\n> **Note:** This value can be used for future transactions with this payment method.
  • exists The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method.
  • echo The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method.
    • street1
    References: Payment Option.Street1
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Street name of the user's mailing address.

    **create The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters.\n\r\n> **Tip:** Including accurate billing address information improves approval rates and may lower interchange costs.
  • exists The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters.
  • echo The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters.
    • street2
    References: Payment Option.Street2
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: STREET
    Additional street name field for entering user's mailing address.

    **create The customer's secondary street address (line 2).\n\r\n> **Note:** Additional street data such as apartment or suite number. Maximum length is 128 characters.
  • exists The customer's street address (line 2).\n\r\n> **Note:** Maximum length is 128 characters.
  • echo The customer's street address (line 2).\n\r\n> **Note:** Maximum length is 128 characters.
    • city
    References: Payment Option.City
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City name of the user's mailing address.

    **create The customer's city.\n\r\n> **Note:** Maximum length is 50 characters.
  • exists The customer's city.\n\r\n> **Note:** Maximum length is 50 characters.
  • echo The customer's city.\n\r\n> **Note:** Maximum length is 50 characters.
    • state
    References: Payment Option.State
    XML Representation: attribute
    Attributes:
    Default Value
    Code of the state associated with a user's mailing address.

    **create The customer's state.\n\r\n> **Note:** State value format is subject to the associated country code. For US addresses, use the two-letter state code.
  • exists The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code.
  • echo The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code.
    • zipCode
    References: Payment Option.ZIP Code
    XML Representation: attribute
    Attributes:
    Default Value
    ZIP or postal code associated with a user's mailing address.

    **create The customer's ZIP or postal code.\n\r\n> **Note:** Format is subject to the associated country code. Maximum length is 15 characters.
  • exists The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters.
  • echo The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters.
    • 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 The customer's country code.\n\r\n> **Note:** Use standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States).
  • exists The customer's country code.\n\r\n> **Note:** Uses standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States).
  • echo The customer's country code.\n\r\n> **Note:** Uses standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States).

    • XML Sample:

    <object accountNumber=""  holderName=""  accountAccessory="" />
    "<object accountNumber=\"\" holderName=\"\" accountAccessory=\"\" />"

    JSON Sample:

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

    XURL Sample:

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