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: ReadOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create Unique transaction ID generated by the system.\n\r\n> **Note:** This field is generated automatically by the system and should not be provided in creation requests.\n\r\n> **Tip:** Reference this identifier throughout the transaction lifecycle.
  • exists Unique transaction ID generated by the system.\n\r\n> **Note:** This identifier is used for referencing the transaction in subsequent API calls.\n\r\n> **Tip:** Store this value to maintain the relationship between your records and the payment platform.
  • echo Unique transaction ID generated by the system.\n\r\n> **Note:** This identifier is used for referencing the transaction in subsequent API calls.\n\r\n> **Tip:** Store this value to maintain the relationship between your records and the payment platform.
    • code
    References: Account Activity.Reference Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    See Reference Code definition for additional information.

    **create Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** Default value is the same as the object's id, which is returned in the response.\n\r\n> **Tip:** This field simplifies reconciliation between systems.
  • exists Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** If not provided in the request, this field will contain the same value as the id field.\n\r\n> **Tip:** This value simplifies matching transactions with your internal records.
  • echo Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** If not provided in the request, this field will contain the same value as the id field.\n\r\n> **Tip:** This value simplifies matching transactions with your internal 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 Specifies which merchant account to use with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** This field routes the transaction to the correct merchant account for processing and reporting.
  • exists Specifies which merchant account was used with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** Ensure this value reflects the correct merchant account to confirm proper transaction routing.
  • echo Specifies which merchant account was used with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** Ensure this value reflects the correct merchant account to confirm proper transaction routing.
    • customerId
    References: Account Activity.Customer Account FK
    XML Representation: attribute
    Attributes:
    Default Value
  • create The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice is being issued.\n\r\n> **Tip:** This field links the invoice to an existing customer. The customer must exist in the system before an invoice can be created.
  • exists The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice was issued.\n\r\n> **Tip:** Reference this identifier for subsequent API calls related to this customer.
  • echo The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice was issued.\n\r\n> **Tip:** Reference this identifier for subsequent API calls related to this customer.
    • createDate
    References: Account Activity.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Date when the record was created

    **create Date when the transaction was created.\n\r\n> **Note:** Date format: yyyy-MM-dd. In the response, the date is returned with hour, minute, and second values as well, formatted as yyyy-MM-dd HH:mm:ss.\n\r\n> **Tip:** This timestamp provides an audit trail for transaction timeline tracking.
  • exists Date when the transaction was created.\n\r\n> **Note:** In the response, the date is returned in yyyy-MM-dd HH:mm:ss format, which includes time components not required in the request.\n\r\n> **Tip:** This timestamp supports reconciliation and auditing processes.
  • echo Date when the transaction was created.\n\r\n> **Note:** In the response, the date is returned in yyyy-MM-dd HH:mm:ss format, which includes time components not required in the request.\n\r\n> **Tip:** This timestamp supports reconciliation and auditing processes.
    • type
    References: Account Activity.Account Activity CL
    XML Representation: attribute
    Attributes: Required
    Default Value
    Represents the type of account activity.

    **create Type of the Transaction to be created. This field is required and determines how the transaction is processed and displayed.\n\r\n> **Note:** For invoice creation, this must be set to the appropriate invoice type value.\n\r\n> **Tip:** Use this field to route the invoice to the correct customer account.
  • exists Type of the Transaction that was created.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Confirm this value matches the expected transaction type for validation.
  • echo Type of the Transaction that was created.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Confirm this value matches the expected transaction type for validation.
    • 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 due.\n\r\n> **Note:** The date must be submitted in yyyy-MM-dd format. Defaults to the current date if no value is passed.\n\r\n> **Tip:** This field helps establish payment expectations and manage cash flow.
  • exists Date when the transaction is due.\n\r\n> **Note:** Returned in yyyy-MM-dd format. If not provided in the request, defaults to the transaction creation date.\n\r\n> **Tip:** This date supports accounts receivable aging reports and collection activities.
  • echo Date when the transaction is due.\n\r\n> **Note:** Returned in yyyy-MM-dd format. If not provided in the request, defaults to the transaction creation date.\n\r\n> **Tip:** This date supports accounts receivable aging reports and collection activities.
    • amount
    References: Account Transaction.Amount
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Amount of the transaction in cents (without a decimal point).

    **create Specifies the total amount of the transaction in cents (not dollars). This field is required and must be a positive integer value.\n\r\n> **Note:** For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value defines how much the customer is expected to pay.
  • exists Total amount of the transaction in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** Verify this value matches your expected amount to ensure transaction accuracy.
  • echo Total amount of the transaction in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** Verify this value matches your expected amount to ensure transaction accuracy.
    • feeAmount
    References: Account Transaction.Fee Amount
    XML Representation: attribute
    Attributes:
    Default Value
  • create Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This field allows tracking processing fees separately from the main transaction amount.
  • exists Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value allows tracking processing fees separately from the main transaction amount.
  • echo Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value allows tracking processing fees separately from the main transaction amount.
    • taxAmount
    References: Account Transaction.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
    Amount of the tax for the transaction.

    **create Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This field supports tax reporting and compliance requirements.
  • exists Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value supports tax reporting and reconciliation requirements.
  • echo Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value supports tax reporting and reconciliation requirements.
    • balance
    References: Account Transaction.Balance
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Remaining balance of the transaction.

    **create Outstanding balance on this transaction, in cents.\n\r\n> **Note:** This field represents the current unpaid amount on the transaction.\n\r\n> **Tip:** Monitor this value to track the remaining amount as payments are applied to the invoice.
  • exists Current outstanding balance on this transaction, in cents.\n\r\n> **Note:** For newly created invoices, this will typically match the amount field until payments are applied.\n\r\n> **Tip:** Monitor this value to track the remaining amount due on the invoice.
  • echo Current outstanding balance on this transaction, in cents.\n\r\n> **Note:** For newly created invoices, this will typically match the amount field until payments are applied.\n\r\n> **Tip:** Monitor this value to track the remaining amount due on the invoice.
    • note
    References: Account Transaction.Note
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TEXT
    Description of the transaction.

    **create Any notes related to the transaction.\n\r\n> **Note:** This field is limited to 255 characters.\n\r\n> **Tip:** Add context or special instructions that may be helpful for internal reference or customer communication.
  • exists Any notes related to the transaction.\n\r\n> **Note:** This field returns any notes that were included in the request. Limited to 255 characters.\n\r\n> **Tip:** This information provides context for the transaction that may be helpful for future reference.
  • echo Any notes related to the transaction.\n\r\n> **Note:** This field returns any notes that were included in the request. Limited to 255 characters.\n\r\n> **Tip:** This information provides context for the transaction that may be helpful for future reference.
    • accountType
    References: Asset Transaction.Transaction CL
    XML Representation: attribute
    Attributes:
    Default Value
    Enumeration of possible asset transaction processing modes available in the system.

    **create Specifies the type of account associated with the transaction.\n\r\n> **Note:** This field determines how the transaction is categorized and processed in the system.\n\r\n> **Tip:** Ensure proper transaction routing and processing with this value.
  • exists Type of account associated with the transaction.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Verify this value to ensure proper transaction categorization.
  • echo Type of account associated with the transaction.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Verify this value to ensure proper transaction categorization.
    • accountNumber
    References: Asset Transaction.Masked Account Number
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Masked account number of the sutomer.

    **create Account number associated with the transaction. If provided, this field contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers when possible.
  • exists Account number associated with the transaction. Contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers for enhanced security.
  • echo Account number associated with the transaction. Contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers for enhanced security.
    • subscriptionId
    References: Account Transaction.Payment Plan FK
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Reference to the entity that represents payment plan of the account.

    **create Identifier of a Subscription that a transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that are created based on a subscription.\n\r\n> **Tip:** This identifier connects the invoice to a specific subscription plan.
  • exists Identifier of a Subscription that the transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that were created based on a subscription.\n\r\n> **Tip:** This value helps track which subscription generated this invoice.
  • echo Identifier of a Subscription that the transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that were created based on a subscription.\n\r\n> **Tip:** This value helps track which subscription generated this invoice.
    • adjustmentId
    References: Account Transaction.Adjustment Transaction FK
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Reference to the entity that represents account transaction.

    **create Identifier of an Adjustment that a transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This field enables tracking transactions created as a result of adjustments.
  • exists Identifier of an Adjustment that the transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This value enables monitoring adjustments that affected this transaction.
  • echo Identifier of an Adjustment that the transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This value enables monitoring adjustments that affected this transaction.
    • 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 Code of the user that created the transaction.\n\r\n> **Note:** Defaults to the API user's username if no value is passed. Limited to 60 characters.\n\r\n> **Tip:** This value helps audit which user or system created each transaction.
  • exists Code of the user that created the transaction.\n\r\n> **Note:** If not provided in the request, defaults to the API user's username. Limited to 60 characters.\n\r\n> **Tip:** This information supports auditing which user or system created each transaction.
  • echo Code of the user that created the transaction.\n\r\n> **Note:** If not provided in the request, defaults to the API user's username. Limited to 60 characters.\n\r\n> **Tip:** This information supports auditing which user or system created each transaction.
    • processingInfo
    Type: ProcessingInfo
    XML Representation: element
    Attributes: ReadOnly
    Default Value
  • create Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction is processed.\n\r\n> **Tip:** This object provides access to the transaction's processing state and related details.
  • exists Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction was processed.\n\r\n> **Tip:** This object provides the complete processing context of the transaction.
  • echo Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction was processed.\n\r\n> **Tip:** This object provides the complete processing context of the transaction.
    • 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:

    <transactions>
     <transaction type=""  amount="" />
</transactions>
    "<transactions> <transaction type=\"\" amount=\"\" /></transactions>"

    JSON Sample:

    {
  "type": "",
  "amount": ""
}

    XURL Sample:

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