Creating One Time Payments

When the third party payment processing system processes a new one time payment, it will call the C1-ThirdPartyOneTimePayNotification inbound web service with an Add action. The payment details include the payment date/time, payment amount and basic details about the payment method (i.e., bank account or credit card).

Note: Because bank account numbers and credit card numbers are captured outside of the system, the full account numbers are not sent. In most cases, only a partial value is sent, e.g. last four digits.
The inbound web service processes the payment as follows:
  • If the Payment Date is the current date, it is processed as an immediate payment.

    • The system creates a Third Party One Time Payment Task, which in turn creates a frozen payment.

    • The payment date/time sent in by the third party payment processor is stored as a characteristic on the payment tender using the Processing Date/Time Characteristic Type in the Third Party One Time Payment Processing Integration master configuration. This is to capture the actual date/time when the payment was processed. This information is used in tender control processing.

      Note: The payment date/time is validated for XSD format. Any subsequent manual updates to this date/time will need to be in the correct XSD format. An adhoc characteristic validation algorithm type C1–VALDATE exists for this purpose.

    • A reference to the Third Party One Time Payment Task’s Service Task ID is stored as a characteristic on the payment tender using the Processing Reference Characteristic Type in the Third Party One Time Payment Processing Integration master configuration. This helps identify that the payment event/tender was created from third party payment processing.

    • The Payment Event ID is sent back to the third party payment processing system so that it has a way to identify the payment should there be a need to cancel the payment in the future.

  • If the Payment Date is a future date, it is processed as a scheduled payment.

    • The system creates a pending Third Party One Time Payment Task. No further action is taken until the third party payment processing system sends another notification that the scheduled payment has been processed.

    • The Service Task ID is sent back to the third party payment processing system so that it has a way to identify the service task on subsequent requests to either update or process the pending one time payment.

Note: To prevent the creation of duplicate payments when the web service times out and the third party payment processing retries the web service call:

  • The system checks if a frozen payment was already created from a previous web service call.

  • The account is locked during payment event creation.

For more information about the lifecycle of the Third Party One Time Payment Notification service task, refer to the C1-ThirdPartyOneTimePayTask business object in the system.

For more information about master configuration settings, refer to the Third Party Payment Processing Integration master configuration in the system.