Third-Party One-Time Payment Notification (C1-ThirdPartyOneTimePayNotification)
This web service is used to notify Oracle Utilities Customer Cloud Service about one-time payments that are processed at a third-party payment processing system.
The actions supported are as follows:
- Adding an immediate or scheduled one-time payment
- Updating the details of a scheduled payment
- Processing a scheduled payment
- Canceling a scheduled or processed payment
The web service creates a service task that performs this processing. Refer to the C1-ThirdPartyOneTimePayTask business object in the application for more details.
Table 4-2 Schema for the Third-Party One-Time Payment Notification (C1-ThirdPartyOneTimePayNotification) web service
| Field | Element Name | Required / Optional | Comments |
|---|---|---|---|
| Header Information (group) | head | n/a | n/a |
| Action | action | Required | Values:
|
| Account ID | accountId | Required | n/a |
| Payment Information (group) | paymentInfo | n/a | n/a |
| Input (group) | input | n/a | n/a |
| Payment DateTime | paymentDateTime | Required | As a standard, inbound and outbound communication with an external system use the standard xsd datetime format - yyyy-MM-dd'T'hh:mm:ss[+|-]hh:mm Example: 2017-02-28T09:15:00-08:00 |
| Payment Amount | paymentAmount | Required | n/a |
| Currency | currency | Optional | If not supplied, CCB will use the currency that is designated on the account. Note: This is for payment processing systems that support multi-currency. |
| Payment Type | paymentType | Required | The base product provides the following values:
|
| Bank Account Information | bankAccountInfo | n/a | Required IF Payment Type is CHECKING or SAVINGS. |
| Account Number | accountNumber | n/a | This should contain only the partial number. For example: The last four digits of the account number |
| Routing Number | routingNumber | n/a | This routing number should be one that is configured on one of the Auto Pay Sources in CCB.(Reason: Auto Pay Source is a required field on the Account Auto Pay which is used to store the enrollment details) |
| Account Name | accountName | n/a | n/a |
| Credit Card Information | creditCardInfo | n/a | This group is required if Payment Type is CREDITCARD. |
| Card Type | cardType | n/a | The base product provides the following values:
|
| Card Number | cardNumber | n/a | This should contain only the partial number. For example: The last four digits of the card number |
| Account Name | accountName | ||
| Expiry Month | expMonth | Format: MM | |
| Expiry Year | expYear | Format: YYYY | |
| Billing Zip Code | zipCode | ||
| Email Address | Optional | ||
| Phone Number | phone | Optional | |
| External Reference Number | extReferenceNumber | Optional | From the third party processor. Can be used to send the payment confirmation number that was sent to the customer. CCB can store this for informational purposes. |
| External Parent Reference Number | extParentRefNumber | Optional | From the third party processor. Can be used to send the confirmation number of the original payment that is being canceled. CCB can store this for informational purposes. |
| External Status | extStatus | Optional | This is the status from the third party processor. CCB can store this for informational purposes. |
| Custom Inputs (group) | customInput | Optional | Not used in CCB base logic. For implementation use only. |
| Field 1 | field1 | ||
| Name | name | ||
| Value | value | ||
| Field 2 | field2 | ||
| Name | name | ||
| Value | value | ||
| Field 3 | field3 | ||
| Name | name | ||
| Value | value | ||
| Field 4 | field4 | ||
| Name | name | ||
| Value | value | ||
| Field 5 | field5 | ||
| Name | name | ||
| Value | value | ||
| Input / Output (group) | input | ||
| Service Task ID | serviceTaskId | Output on add (C1AD) action. This is a required input on cancel (C1CA) of a processed payment. This is a required input on cancel (C1CA), update (C1UP) or process (C1PR) of a scheduled (future-dated) payment. | |
| Payment Event ID | paymentEventId | Output on add (C1AD) and process (C1PR) actions. This is a required input on cancel (C1CA) of a processed payment. | |
| Payment Cancel Reason | cancelReason | Required input on cancel (C1CA) of a processed payment. This must be a valid Pay Cancel Reason defined in the Third Party Payment Processing Integration master configuration. | |
| Output (group) | output | ||
| Cancellation Service Task ID | cancellationServiceTaskId | Output on cancel (C1CA) action | |
| Payment Cancel Reasons List | payCancelReasonsList | Output on read (C1RE) action | |
| Cancel Reason | cancelReason | ||
| Cancel Reason Description | description | ||
| Informational Message | infoMessage | Output on cancel (C1CA) action when the input Cancel Reason is invalid or not supplied. The message will indicate that the system default cancel reason was used. | |
| Custom Outputs (group) | customOutput | Optional | Not used in CCB base logic. For implementation use only. |
| Field 1 | field1 | ||
| Name | name | ||
| Value | value | ||
| Field 2 | field2 | ||
| Name | name | ||
| Value | value | ||
| Field 3 | field3 | ||
| Name | name | ||
| Value | value | ||
| Field 4 | field4 | ||
| Name | name | ||
| Value | value | ||
| Field 5 | field5 | ||
| Name | name | ||
| Value | value | ||
| Error Information (group) | errorInformation | ||
| Is In Error | isInError | Boolean | |
| Error Reference (group) | errorReference | ||
| Message Category | category | ||
| Message Number | number | ||
| Error Message Text | errorMessage |