Third-Party Automatic Payment Setup (C1-ThirdPartyAutoPaySetup)
This web service is used to set up an account for recurring automatic payments, such as automatic bill pay. Oracle Utilities Customer Cloud Service creates an Account Auto Pay record using the supplied information.
The web service creates a service task that performs this processing. Refer to the C1-ThirdPartyAutoPayTask business object in the application for more details.
Table 4-3 Schema for the Automatic Payment Setup (C1-ThirdPartyAutoPaySetup) web service
| Field | Element Name | Required / Optional | Comments |
|---|---|---|---|
| Header Information (group) | head | ||
| Action | action | Required | Values:
|
| Account ID | accountId | Required | |
| Auto Pay Information (group) | autoPayInformation | ||
| Input (group) | input | ||
| Start Date | startDate | Required if Action is add (C1AD) or update (C1UP) | |
| End Date | endDate | Required if Action is C1CN | |
| Payment Type | paymentType | Required | The base product provides the following values:
|
| Credit Card Type | cardType | Required if Payment Type is CREDITCARD. The base product provides the following values:
|
|
| Account Number | externalAccountId | Required | Applicable to all Payment Types. This should be a partial number.
Example: The last four digits of the account/card number. |
| Expiry Month | expMonth | Required if Payment Type is CREDITCARD | |
| Expiry Year | expYear | Required if Payment Type is CREDITCARD | |
| Name on Account | name | Required | |
| Routing Number | bankRoutingNumber | 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) | |
| Maximum Amount | maxWithdrawAmount | Optional | |
| External Reference Number | externalReferenceNumber | Optional | From the third party processor. Can be used to send the confirmation number that was sent to the customer. 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) | inputOutput | ||
| Account Auto Pay ID | autoPayId | This is output on add (C1AD) action. It is a required input on an update (C1UP) or a cancel (C1CN) action. | |
| Output (group) | output | ||
| 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 |