Transaction

Type:  
Abstract:  no
Status:  Active
Java Class:  Transaction
Represents a transaction associated with a particular merchant.
Available Fields:
id
References: Account Activity.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create Unique Transaction ID generated by the system.

  • exists
    • Unique Transaction ID generated by the system.

  • echo
    • Unique Transaction ID used for filtering Transaction records.
    code
    References: Account Activity.Reference Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    See Reference Code definition for additional information.

    **create Unique Transaction 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 Transaction 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 Transaction ID used for filtering records.
    accountId
    References: Account Activity.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 will be associated with Transaction.
    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 Transaction.
    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
    References: Account Activity.Customer Account FK
    XML Representation: attribute
    Attributes:
    Default Value
  • create
    • Identifier of a Customer that a Transaction will be associated with.

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

  • echo
    • Identifier of a Customer used as a search criteria to limit results.
    createDate
    References: Account Activity.Create Date
    XML Representation: attribute
    Attributes:
    Default Value
    Date when the record was created

    **create Date when the Transaction was created.
    Note: Date format: yyyy-MM-dd.


  • exists
    • Date when the Transaction was created.
    Note: Date format: yyyy-MM-dd.


  • echo
    • Date used for filtering Transaction records.
    dueDate
    References: Account Transaction.Due Date
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Date when the transaction becomes effective.

    **create Date when the Transaction is expected to be completed.

  • exists
    • Date when the Transaction is expected to be completed.

  • echo
    • type
    References: Account Activity.Account Activity CL
    XML Representation: attribute
    Attributes: Required
    Default Value
    Represents the type of account activity.

    **create Type of a Transaction that will be created.
    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 Account Activity Classifier. </div>

  • exists
    • Type of a Transaction.
    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 Account Activity Classifier. </div>

  • echo
    • Type of a Transaction used for the search criteria to limit results.
    accountType
    References: Asset Transaction.Transaction CL
    XML Representation: attribute
    Attributes:
    Default Value
    Enumeration of possible asset transaction processing modes available in the system.

    **create Type of a payment method to be used. <div class="info legacy"> For more information see Asset Transaction Classifier. </div>
  • exists
    • Type of a payment method used. <div class="info legacy"> For more information see Asset Transaction Classifier. </div>
  • echo
    • Type of a payment method used for the search criteria to limit results.
    creatorCode
    References: Account Transaction.Ref Creator Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    Code of the user that created the account transaction.

    **create Identifier of a user (provided by an integrator) initiating the request.
    Note: This field typically references a user within your system whose actions resulted in this request. Defaults to your API's userName if no value is provided.


  • exists
    • Identifier of a user (provided by an integrator) initiating the request.
    Note: This field typically references a user within your system whose actions resulted in this request. Defaults to your API's userName if no value is provided.


  • echo
    • Identifier of a user (provided by an integrator) used as a search criteria to limit results.
    amount
    References: Account Transaction.Amount
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Amount of the transaction in cents (without a decimal point).

    **create Amount (in cents) of the Transaction.

  • exists
    • Amount (in cents) of the Transaction.

  • echo
    • Amount (in cents) used for filtering Transaction records.
    balance
    References: Account Transaction.Balance
    XML Representation: attribute
    Attributes:
    Default Value
    Remaining balance of the transaction.

    **create Current balance of the Transaction.

  • exists
    • Current balance of the Transaction.

  • echo
    • Current balance of the Transaction used for filtering records.
    accountNumber
    References: Asset Transaction.Masked Account Number
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Masked account number of the sutomer.

    **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 as a search criteria to limit results.
    note
    References: Account Transaction.Note
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TEXT
    Description of the transaction.

    **create Any additional details associated with a Transaction.

  • exists
    • Any additional details associated with a Transaction.

  • echo
    • adjustmentId
    References: Account Transaction.Adjustment Transaction FK
    XML Representation: attribute
    Attributes:
    Default Value
    Reference to the entity that represents account transaction.

    **create Identifier of an Adjustment that a Transaction will be associated with.

  • exists
    • Identifier of an Adjustment that a Transaction is associated with.

  • echo
    • Identifier of an Adjustment used for filtering Transaction records.
    subscriptionId
    References: Account Transaction.Payment Plan FK
    XML Representation: attribute
    Attributes:
    Default Value
    Reference to the entity that represents payment plan of the account.

    **create Identifier of a Subscription that a Transaction will be associated with.
    Used for transactions of type: RI - Invoice. <br>Note: when the Invoice transaction is created based on a subscription.
    <div class="info legacy"> For more information see Account Activity Classifier. </div>

  • exists
    • Identifier of a Subscription that a Transaction is associated with.
    Used for transactions of type: RI - Invoice. <br>Note: when the Invoice transaction is created based on a subscription.
    <div class="info legacy"> For more information see Account Activity Classifier. </div>

  • echo
    • Identifier of a Subscription used for filtering Transaction records.
    processingInfo
    Type: ProcessingInfo
    XML Representation: element
    Attributes:
    Default Value
  • create
    • Information associated with a processing of the transaction.
    Note: This field only is included in a transaction record if the transaction has been processed.


  • exists
    • Information associated with a processing of the transaction.
    Note: This field only is included in a transaction record if the transaction has been processed.


  • echo
    • feeAmount
    References: Account Transaction.Fee Amount
    XML Representation: attribute
    Attributes:
    Default Value
  • create
    • Fee amount (in cents) that will be associated with the transaction processing.

  • exists
    • Fee amount (in cents) associated with the transaction processing.

  • echo
    • Fee amount used for filtering Transaction records.
    taxAmount
    References: Account Transaction.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
    Amount of the tax for the transaction.

    **create Tax amount (in cents) that will be associated with the transaction processing.

  • exists
    • Tax amount (in cents) associated with the transaction processing.

  • echo
    • Tax amount used for filtering Transaction records.
    invoiceList
    References: Account Transaction.Invoice List
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: NUMERIC
  • create
    • List of invoice references that are expected to be covered by this transaction.

  • exists
    • List of invoice references that are expected to be covered by this transaction.

  • echo
    • List of invoice references used for filtering records.

    XML Sample:

    <transaction type=""  amount=""  subscriptionId="3271" />
    "<transaction type=\"\" amount=\"\" subscriptionId=\"3271\" />"

    JSON Sample:

    {
  "type": "",
  "amount": "",
  "subscriptionId": 3271
}

    XURL Sample:

    ?type=&amount=&subscriptionId=3271&
    type=
    amount=
    subscriptionId=3271
    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.