This transaction requests credit validation for orders that are pending authorization or charging.
Use this transaction for creating authorization and charge requests.
This transaction works in combination with the Payment Execution transaction. Although this transaction can run independent of that transaction, authorization and collection occurs only after the Payment Execution dependencies are met. For more details, see Payment execution.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | PAYMENT_COLLECTION |
Base Document Type | Order |
Base Process Type | Order Fulfillment |
Abstract Transaction | No |
APIs Called | requestCollection() |
Attribute | Value |
---|---|
Base Transaction ID | PAYMENT_COLLECTION.0003 |
Base Document Type | Order |
Base Process Type | Reverse Logistics |
Abstract Transaction | No |
APIs Called | requestCollection() |
The following are the criteria parameters for this transaction:
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. |
EnterpriseCode | Optional. The enterprise for which the transaction needs to be run. If left blank, orders for all enterprises are processed. If specified, only orders for that enterprise are processed. |
ColonyID | Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
HoldTypeOnRollback | If the HoldTypeOnRollback criteria is populated and the requestCollection agent throws an exception, for example, from the getFundsAvailable user exit, HoldTypeOnRollback will be used to put the order on hold. If using the old order hold functionality, this will be used as the hold reason. If the hold type does not exist, an exception is thrown. If the HoldTypeOnRollback criteria is not populated, the order will not be put on hold if an exception is thrown. |
The following statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumOrdersProcessed | Number of orders processed. |
NumChargeReqsCreated | Number of charge requests created. |
NumAuthorizationReqsCreated | Number of authorization requests created. |
For this transaction the pending job count is the number of orders in the appropriate payment statuses with the value of the AUTHORIZATION_EXPIRATION_DATE is less than or equal to (<=) the current date. The appropriate payment statuses for such orders are:
The following events are raised by this time-triggered transaction:
Transaction/Event | Key Data | Data Published | Template Support? |
---|---|---|---|
INCOMPLETE_PAYMENT |
modifyOrder |
YFS_PAYMENT_ |
Yes |
PAYMENT_STATUS | YFS_PAYMENT |
YFS_PAYMENT_ |
Yes |
REQUEST_PAYMENT_ |
YFS_PAYMENT_ |
Yes | |
ON_LIABILITY_ |
modifyOrder |
YFS_PAYMENT_ |
Yes |
ON_INVOICE_ |
order_dbd/txt |
YFS_CREATE_ORDER_ |
Yes |