Summary
Payment Attributes allow administrators to add a fee or other payment to a Workflow Step.
Data Storage
This attribute stores a reference to the TRANSACTION_HISTORY
table, pointing to the Transaction that was made to satisfy the payment.
Additionally, a TRANSACTION_LINE_ITEM
record will point back to this Attribute value using the PURCHASED_ITEM_ID
column.
There are scenarios in which a Payment attribute can be associated with multiple Transactions:
When a Payment is fully refunded, its value is cleared out to allow it to be paid again;
When a Payment "rolls over" (e.g. when a Payment is cleared out so that it can track annual payments)
In these cases, the Payment will only ever point to the most recent Transaction. There may exist multiple TRANSACTION_HISTORY
records that are no longer directly associated to the Payment.
Linking those historical transactions to a Payment attribute can only be done by joining on the line item's Description, and only as long as the payment descriptions haven't changed.
To make a Payment attribute eligible for payment again, you must delete the ITEM_ATTRIBUTE_VALUE
record that holds the reference to the Transaction.
Simply setting the attribute value to empty will only partially work; the Attribute will be considered "unpaid", but the checkout process may block progress because a historical TRANSACTION_LINE_ITEM.PURCHASED_ITEM_ID
value still points to the ITEM_ATTRIBUTE_VALUE
record, causing the payment system to believe the payment is a duplicate.
Know Issues / Limitations
Note | References | |
---|---|---|
1 | If a Payment Attribute is used to grant a Role on the Grant Role Workflow, any Learning Plan set to automatically begin when eligible will not begin automatically. |