Mass Payment Tender Cancellation
Oracle Revenue Management and Billing provides the ability to cancel multiple payment tenders at once through the Upload Request feature. As a result, the payments associated with each payment tender are automatically canceled without stating their respective payment event ID or payment ID. The system derives the payment event associated with the payment tender and then accordingly cancels the payment tender and all the payments associated with the payment tender. The C1-TndrCnclUploadRequest business object enables you to create an upload request for mass payment tender cancellation.
You need to create an upload request type for the C1-TndrCnclUploadRequest business object. You can then upload a mass payment tender cancellation file in the CSV format using the respective upload request type. The mass payment tender cancellation file should contain records with the following information – external reference ID or check number, external source ID, tender type, tender amount, cancel reason, bank code, bank account and tender characteristics. For more information, see Mass Payment Tender Cancellation CSV Format.
You can specify maximum 5 characteristics in the record.
Through an upload request, you cannot cancel those payment tenders where both the external reference ID and check number are not specified in the system. You can cancel such payment tenders manually from the user interface.
On uploading a mass payment tender cancellation file, the system creates an upload request in the Draft status. The data records are created in the Pending status. The system validates the following for each record:
-
Either the external reference ID or check number is specified in the record.
-
Cancel reason is specified in the record.
The system then derives the payment tender using the external reference ID or check number and the payment event associated with the respective payment tender. It also considers additional filters, such as external source ID, tender type, and/or tender amount, if any, given in the record while deriving the payment tender. Note that if both the external reference ID and check number are given in the record, the system considers only external reference ID and not check number while deriving the payment tender. If the system could not derive the payment tender and payment event, the status of the record is changed to Invalid. In addition, if any of the above validations fail, the status of the record is changed to Invalid.
On clicking the Validate button, the system checks whether the upload request must be validated in the real time (i.e., immediately) or in the deferred mode (i.e., in the background). If the total number of records in the upload request does not exceed the online record validate limit, the system validates the following in the real time:
-
The derived payment event ID is valid.
-
The derived payment event does not have multiple payment tenders associated with it.
-
The payment cancel reason given in the record is valid.
-
The payment tender is not in the Canceled status.
-
Any payment of the payment event is not in the Incomplete, Freezable, Error, or Canceled status.
-
Any payment of the payment event is either not partially or fully refunded to the customer.
-
The bank code given in the record is valid.
-
The bank account is defined for the respective bank code in the system.
-
The bank code is available when the bank account is specified in the record and vice versa.
If any of above validations fail, the status of the record is changed to Invalid. However, if all the above validations are successful, the status of the record is changed to Valid. Once all the pending records in the upload request are validated, the status of the upload request is changed to Validated.
However, if the total number of records in the upload request exceeds the online record validate limit, the system changes the status of the upload request to Deferred Validation. The system then validates the records and changes the status of the upload request from Deferred Validation to Validated when the C1-UPLRQ batch is executed.
On clicking the Submit button, the system checks whether the approval is required for the upload request. If the approval is required for the upload request, the status of the upload request is changed to Approval In Progress. However, if the approval is not required for the upload request, the status of the upload request is changed to Submitted.
The approver can either approve or reject the upload request based on the observations. On approving an upload request, the status of the upload request is changed to Approved. However, on rejecting an upload request, the status of the upload request is changed to Rejected.
Once the status of the upload request is changed to Submitted or Approved, the system checks whether the upload request must be processed in the real time (i.e., immediately) or in the deferred mode (i.e., in the background). If the number of valid records in the upload request does not exceed the online record process limit, the system changes the status of the upload request to Processing. However, if the number of valid records in the upload request exceeds the online record process limit, the system changes the status of the upload request to Deferred Processing. The system then changes the status of the upload request from Deferred Processing to Processing when the C1-UPLRQ batch is executed.
Once the status of the upload request is changed to Processing, the system fetches a list of records which are in the Valid status. For each valid record, the system cancels the payment tender and all the payments of the associated payment event. It changes the status of the payment tender and its associated payments to Canceled. While canceling a payment tender, it requires the cancel reason that indicates the reason why the payment tender and its associated payments are canceled. In addition, the system stamps the characteristics given in the record on the respective payment tender after canceling it.
Once the payment tender and its associated payments are successfully canceled, the status of the record is changed to Processed. However, if any error occurs while canceling the payment tender and its associated payments, the status of the record is changed to Error. Finally, the status of the upload request is changed to Processed.
