Subscription Transaction UML

Added On: 09/25/15

SQL Table: SUBSCRIPTION_TRANSACTION

Module: UniCharge

Type: Entity Status: Active

Java Class: SubscriptionTransaction

Entity that represents information about subscription transaction.

Available Fields:

Account Accessory
Account Accessory Masked
Account CL
Account Number
Account Number Last4
Account Number Masked
Bank Info FK
City
Country Code
Create Date
Customer Account Code
Data Hash1

Data Hash2
Duplicate Code
Email
External Subscription Code
First Name
Id
Is Organization
Last Name
Merchant Account Code
Phone
Provider Reference Number
Provider Response Code

Provider Response Message
Request Type
Response Code
Response Date
Response Message
State
Status CL
Street
Token
Token Code
Transaction Code
ZIP Code

Account Accessory

Added On: 09/25/15

SQL Column: ACCOUNT_ACCESSORY

Java Field: accountAccessory

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Expiration date or routing number of the transaction.

Account Accessory Masked

Added On: 09/25/15

SQL Column: ACCOUNT_ACCESSORY_MASKED

Java Field: accountAccessoryMasked

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

Masked account accessory number.

Account CL

Added On: 01/13/16

SQL Column: ACCOUNT_CL

Java Field: accountCl

Status: Active

SQL Type: varchar(2)

Java Type: String

References Account Classifier

Attributes:

Represents the type of the bank account associated with the transaction.

Account Number

Added On: 09/25/15

SQL Column: ACCOUNT_NUMBER

Java Field: accountNumber

Status: Active

SQL Type: varchar(80)

Java Type: String

Attributes:

Number of the customer's bank account.

Account Number Last4

Added On: 09/25/15

SQL Column: ACCOUNT_NUMBER_LAST4

Java Field: accountNumberLast4

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Last four digits of the bank account or credit card number.

Account Number Masked

Added On: 09/25/15

SQL Column: ACCOUNT_NUMBER_MASKED

Java Field: accountNumberMasked

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Masked version of the account number (credit card or bank account) associated with this transaction. The mask is formed by using the first and last digits of the account, e.g. 4********5655.

Bank Info FK

Added On: 06/10/16

SQL Column: BANK_INFO_FK

Java Field: bankInfo

Status: Active

SQL Type: int(11)

Java Type: Integer

References Bank Info

Attributes:

Reference to the entity that represents information about the bank.

City

Added On: 09/25/15

SQL Column: CITY

Java Field: city

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

City of the mailing address associated with this customer account.

Country Code

Added On: 09/25/15

SQL Column: COUNTRY_CODE

Java Field: countryCode

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

Country code of the mailing address associated with this customer account.

Create Date

Added On: 09/25/15

SQL Column: CREATE_DATE

Java Field: createDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the record was created

Customer Account Code

Added On: 09/25/15

SQL Column: CUSTOMER_ACCOUNT_CODE

Java Field: customerAccountCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Value identifying the customer in a submitter’s system.

Data Hash1

Added On: 09/25/15

SQL Column: DATA_HASH1

Java Field: dataHash1

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Data used for identification of the subscription that contains an account number.

Data Hash2

Added On: 10/28/15

SQL Column: DATA_HASH2

Java Field: dataHash2

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Data used for identification of the subscription that contains a token.

Duplicate Code

Added On: 10/27/15

SQL Column: DUPLICATE_CODE

Java Field: duplicateCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Identifier of the original transaction assigned to this duplicate record.

Added On: 09/25/15

SQL Column: EMAIL

Java Field: email

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Email address associated with this customer account.

External Subscription Code

Added On: 03/14/17

SQL Column: EXTERNAL_SUBSCRIPTION_CODE

Java Field: externalSubscriptionCode

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Identifier of the subscription assigned within the processor's system.

First Name

Added On: 09/25/15

SQL Column: FIRST_NAME

Java Field: firstName

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

First name of the customer.

Added On: 09/25/15

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Unique, Required, CreateOnly, ReadOnly

Identifier of the object used for references; auto-incremented integer value.

Is Organization

Added On: 09/25/15

SQL Column: IS_ORGANIZATION

Java Field: isOrganization

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the specified customer is an organization.

Last Name

Added On: 09/25/15

SQL Column: LAST_NAME

Java Field: lastName

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Last name of the customer.

Merchant Account Code

Added On: 09/25/15

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required

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.

Phone

Added On: 06/10/16

SQL Column: PHONE

Java Field: phone

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

Phone number associated with this customer account.

Provider Reference Number

Added On: 09/25/15

SQL Column: PROVIDER_REFERENCE_NUMBER

Java Field: providerReferenceNumber

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Returns reference number of underlying processor.

Provider Response Code

Added On: 01/15/16

SQL Column: PROVIDER_RESPONSE_CODE

Java Field: providerResponseCode

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Response code generated by a processor.

Provider Response Message

Added On: 01/15/16

SQL Column: PROVIDER_RESPONSE_MESSAGE

Java Field: providerResponseMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Response message generated by a processor.

Request Type

Added On: 06/10/16

SQL Column: REQUEST_TYPE

Java Field: requestType

Status: Active

SQL Type: varchar

Java Type: String

Attributes: Transient, Default:subscription

Type of the request. For subscription request type the value is Subscription.

Response Code

Added On: 09/25/15

SQL Column: RESPONSE_CODE

Java Field: responseCode

Status: Active

SQL Type: varchar(5)

Java Type: String

Attributes:

Response code generated by the gateway.

Response Date

Added On: 09/25/15

SQL Column: RESPONSE_DATE

Java Field: responseDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date of the response generated by the gateway.

Response Message

Added On: 09/25/15

SQL Column: RESPONSE_MESSAGE

Java Field: responseMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Response message generated by the gateway.

State

Added On: 09/25/15

SQL Column: STATE

Java Field: state

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

State of the mailing address associated with this customer account.

Status CL

Added On: 09/25/15

SQL Column: STATUS_CL

Java Field: statusCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Transaction Status Classifier

Attributes:

Represents current status of the subscriptions/mandate processing.

Street

Added On: 09/25/15

SQL Column: STREET

Java Field: street

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

Street of the mailing address associated with this customer account.

Token

Added On: 10/23/15

SQL Column: TOKEN

Java Field: token

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Token value replacing bank account number.

Token Code

Added On: 10/23/15

SQL Column: TOKEN_CODE

Java Field: tokenCode

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Token generated for the provided payment information. Always present when tokenization service is enabled.

Transaction Code

Added On: 09/25/15

SQL Column: TRANSACTION_CODE

Java Field: transactionCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Value identifying the transaction in a submitter’s system.

ZIP Code

Added On: 09/25/15

SQL Column: ZIP_CODE

Java Field: zipCode

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

ZIP or postal code of the mailing address associated with this customer account.