Payment Creation, Cancellation, Transfer, and View Through Inbound Web Service

Oracle Revenue Management and Billing enables you to create, transfer, cancel, and view payments through a web service. You can send the payment creation, payment transfer, payment cancellation, or payment view request from the external system through an inbound web service. The following four business services are shipped with the product to support different payment operations:

Business Service Description
C1-CreatePayment

Used to create payments for an account. While sending the payment creation request, you need to specify either of the following of the payor and payee accounts:

  • Account ID

  • Account Identifier Type, Account Identifier, and Division

The system enables you to create a payment through the web service using either of the following match types:

  • Bill

  • Contract

You can specify maximum four tender types along with the amount. You can specify maximum four characteristics for payment tender and maximum five characteristics for payment.

On processing the payment creation request, the system calculates the sum of tender amount and sets it as the payment amount. It creates the payment event and payments. The payments are immediately distributed and frozen. It also creates a payment tender for each tender type.

If the number of bill segments in a bill exceeds the bill segment count specified in the C1_​PAYBYBTCH feature configuration, the system distributes and freezes the payments in the deferred mode and not in real time (i.e. immediately). The system creates a batch job using the C1-PAYBT batch and accordingly sends the response to the external system. For more information, see C1-CreatePayment Business Service

C1-CancelPayment

Used to cancel a payment or all payments of a payment event. While sending the payment cancellation request, you can specify either of the following cancellation types:

  • T - Used to indicate that you want to cancel all payments of a payment event along with its payment tenders.

  • P - Used to indicate that you want to cancel a particular payment.

On processing the payment cancellation request, the system cancels the payment and changes the status of the payment to Canceled. For more information, see C1-CancelPayment Business Service

C1-TransferPayment

Used to transfer a payment or all payments of a payment event. While sending the payment transfer request, you can specify either of the following transfer types:

  • E - Used to indicate that you want to transfer all frozen payments of a payment event.

  • P - Used to indicate that you want to transfer a particular payment.

The system enables you to transfer a payment through the web service using either of the following match types:

  • Bill

  • Contract

You need to specify a reason why you want to transfer a payment. On processing the payment transfer request, the system cancels the old payment and creates a new payment on the payment event in the Frozen status. For more information, see C1-TransferPayment Business Service

C1-ViewPayment

Used to view the payments of an account. While sending the payment view request, you need to specify either of the following:

  • Account ID

  • Account Identifier Type, Account Identifier, and Division

You can specify various criteria (such as, tender type, check number, payment creation date range) along with the account details to filter the list of payments. You can specify the maximum number of records that can be retrieved through the C1-ViewPaymentService business service in the Set Fetch Record Limit option type of the C1-RECLMT feature configuration. Accordingly, the system lists the number of payments in the payment view response. For example, if the value in the Set Fetch Record Limit option type is set to 100 and the result set contains 125 payments, the system will list only 100 payments of the account from the result set in the descending order of the creation date. For more information, see C1-ViewPayment Business Service

The system enables you to track the payment creation, payment transfer, payment cancellation, and payment view responses sent to the external system using the Inbound Web Service History feature.

We have not shipped any inbound web service with the product. You can create one inbound web service which supports all four operations - payment creation, payment transfer, payment cancellation, and payment view. Alternatively, you can create four inbound web services - one for payment creation, second for payment transfer, third for payment cancellation, and fourth for payment view.

You can create a SOAP or REST based inbound web service. If you want to send the request in the XML and/or JSON format, you need to ensure that you create a REST based inbound web service. However, if you want to send the request in the XML format, you can create a SOAP or REST based inbound web service.

Parent Topic: Payments