Payment execution

The payment execution transaction processes all requests that are pending authorization and charging.
Note: If the charge transaction request has an open authorization reversal, the charges are not collected.

Use this time-triggered transaction for processing all authorization and charge requests.

This transaction requires interfacing with a product that provides financial services.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Payment execution attributes for sales orders
Attribute Value
Base Transaction ID PAYMENT_EXECUTION
Base Document Type Order
Base Process Type Order Fulfillment
Abstract Transaction No
APIs Called executeCollection()
User Exits Called collectionCreditCard, collectionOthers, collectionCustomerAcct
Table 2. Payment execution attributes for return orders
Attribute Value
Base Transaction ID PAYMENT_EXECUTION.0003
Base Document Type Order
Base Process Type Reverse Logistics
Abstract Transaction No
APIs Called executeCollection()
User Exits Called collectionCreditCard, collectionOthers, collectionCustomerAcct

Criteria parameters

The following are the criteria parameters for this transaction:

Table 3. Payment execution criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
ChargeType Type of credit card process. Valid values are:
  • AUTHORIZATION - Validates the credit card account
  • CHARGE - Applies the charge to the credit card
ColonyID Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 4. Payment execution statistics
Statistic Name Description
NumAuthTransProcessed Number of authorization transaction processed.
NumAuthTransSuccessfullyProcessed Number of successful returns from user exit for authorization transaction processed.
NumChargeTransProcessed Number of charge transaction processed.
NumChargeTransSuccessfullyProcessed Number of successful returns from user exit for charge transaction processed.
NumCollectionValidations Number of successful returns from the invoked validate collection user exits.
NumCreditCardCollections Number of credit card collections.
NumCustomerAccountCollections Number of successful returns from the customer account collection user exits.
NumOtherCollections Number of successful returns from the other collection user exits.

Pending job count

For this transaction the pending job count is the number of open charge and authorization transactions.

Events raised

The following events are raised by this time-triggered transaction:

Table 5. Events raised by payment execution transaction
Transaction/Event Key Data Data Published Template Support?
CHARGE_FAILED
modifyOrder
dbd.txt
PAYMENT_EXECUTION_
CHARGE_FAILED_dbd.txt
No

This transaction raises events as specified under the executeCollection() API in the IBM Sterling Order Management: Javadoc.