PPCPAYINST

This table stores the value object Payment Instruction in HCL Commerce which contains the detailed information required by plug-ins to process financial transactions. The amount in the payment instruction can be used by plug-ins to determine what is the maximum target amount the payments subsystem intends to consume collectively.

Column Descriptions:

NameTypeDescription
PPCPAYINST_IDBIGINT NOT NULLThe generated payment instruction identifier
ORDER_IDBIGINTOMS order identifier; null when this payment instruction is not associated to any order
RMA_IDBIGINTThe returns' RMA identifier; null when this payment instruction is not associated to any RMA
STORE_IDINTEGER NOT NULLThe store identifier to which this payment instruction is associated
AMOUNTDECIMAL (20,5) NOT NULLThe maximum amount that will be used on this payment instruction to process Payments/Credits. This is what Payment Rules will expect to use but it could be less than this amount. No more amount is allowed. If Payment Rules wants to use more amount, it must increase the amount by call the editPaymentInstruction API.
APPROVINGAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payments with pending approve transactions under this payment instruction
APPROVEDAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payments that have been approved under this payment instruction
CREDITINGAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all credits with pending credit transactions under this payment instruction
CREDITEDAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all credits that have been credited under this payment instruction
DEPOSITINGAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payment with pending deposit transactions under this payment instruction.
DEPOSITEDAMOUNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payment that have been deposited under this payment instruction
RVRSNGAPRVEDAMNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payments with pending reverse approval transactions under this payment instruction
RVRSNGDPSTEDAMNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all payments with pending reverse deposit transactions under this payment instruction
RVRSNGCRDTEDAMNTDECIMAL (20,5) NOT NULL DEFAULT 0.00000This is a cumulative value of all credits with pending reverse credit transactions under this payment instruction
TIMECREATEDTIMESTAMP NOT NULLThe time when the payment instruction was created
TIMEUPDATEDTIMESTAMP NOT NULLThe time when the payment instruction was updated
CURRENCYCHAR (3) NOT NULLThe currency used when the order was placed
STATESMALLINT NOT NULL DEFAULT 0The state of this payment instruction: 0: STATE_NEW 1: STATE_VALID 2: STATE_INVALID 3: STATE_CLOSED
MARKFORDELETEINTEGER NOT NULL DEFAULT 0The flag indicates whether this object has been marked for deletion. 0: not marked for deletion 1: marked for deletion
OPTCOUNTERSMALLINT NOT NULL DEFAULT 0The optimistic concurrency control counter for the table. Every time there is an update to the table, the counter is incremented.
PLUGINNAMEVARCHAR (64) NOT NULLThe plug-in name which is used to process the financial transactions for this payment instruction. This is retrieved from the PaymentSystemPluginMapping.xml when this payment instruction is created
PAYMENTSYSTEMNAMEVARCHAR (64) NOT NULLThe name of the payment system that is used to process financial transactions for this payment instruction; This name is used to find out the corresponding plug-in for a payment configuration group
ACCOUNTNUMBERVARCHAR (512)The account number for different payment method (Credit Card number, checking account, Gift Certificate number, etc); an empty string means the payment instruction does not contain account numbers.
PAYCONFIGIDVARCHAR (64) NOT NULLThe payment configuration id which is used by this payment instruction

Indexes:

NameColumn NamesType
<SYSTEM-GENERATED>PPCPAYINST_IDPrimary Key
I0000918ORDER_ID+MARKFORDELETENon-Unique Index
I0000919RMA_ID+MARKFORDELETENon-Unique Index

Referenced By Child Tables:

ConstraintColumnsChild TableChild ColumnsType
F_1168PPCPAYINST_IDPPCPAYMENTPPCPAYINST_IDCascade
F_1170PPCPAYINST_IDPPCCREDITPPCPAYINST_IDCascade
F_1174PPCPAYINST_IDPPCEXTDATAPPCPAYINST_IDCascade