UniPay Gateway Documentation

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.

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:

See Reference Code definition for additional information.

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.

customerId

References: Account Activity.Customer Account FK

XML Representation: attribute

Attributes:

Default Value

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.

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.

type

References: Account Activity.Account Activity CL

XML Representation: attribute

Attributes: Required

Default Value

Represents the type of account activity.

dueDate

References: Account Transaction.Due Date

XML Representation: attribute

Attributes: CreateOnly

Default Value

Date when the transaction becomes effective.

The date must be submitted in yyyy-MM-dd format.

amount

References: Account Transaction.Amount

XML Representation: attribute

Attributes: Required, CreateOnly

Default Value

Amount of the transaction in cents (without a decimal point).

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.

balance

References: Account Transaction.Balance

XML Representation: attribute

Attributes: ReadOnly

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.

note

References: Account Transaction.Note

XML Representation: attribute

Attributes: CreateOnly

Default Value

Pattern:

Description of the transaction.

accountType

References: Asset Transaction.Transaction CL

XML Representation: attribute

Attributes:

Default Value

Enumeration of possible asset transaction processing modes available in the system.

accountNumber

References: Asset Transaction.Masked Account Number

XML Representation: attribute

Attributes: CreateOnly

Default Value

Masked account number of the sutomer.

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 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.

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 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.

creatorCode

References: Account Transaction.Ref Creator Code

XML Representation: attribute

Attributes: CreateOnly

Default Value

Pattern:

Code of the user that created the account transaction.

processingInfo

Type: ProcessingInfo

XML Representation: element

Attributes: ReadOnly

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

invoiceList

References: Account Transaction.Invoice List

XML Representation: attribute

Attributes:

Default Value

Pattern:

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.

Transaction

XML Sample:

JSON Sample:

XURL Sample: