Third-Party Account Verification (C1-ThirdPartyVerifyAccount)

This web service is used to verify an account either before capturing a one-time payment or before processing an auto pay setup/enrollment. It checks that an input Account ID exists in Oracle Utilities Customer Cloud Service, and if so, returns the account’s balance, past due amount (if any), bill due and any existing account auto pay options. The existing account auto pay option information is useful when verifying the account prior to auto pay setup/enrollment. The third-party payment processors can use this to determine how to handle the auto pay enrollment request.

Example: If the account is already enrolled in auto pay, the third-party payment processor will know if the new enrollment overlaps or duplicates the existing enrollment and if the existing enrollment is just being updated.

The web service creates a service task that performs this processing. Refer to the C1-ThirdPartyAcctVerifTask business object in the application for more details about this service task.

Table 4-1 Schema for the Third-Party Account Verification (C1-ThirdPartyVerifyAccount) Web Service

Field Element Name Required/Optional Comments
Header Information (group) head n/a n/a
Action action Required Value: C1VE (Verify)
Account ID accountId Required n/a
Account Verification (group) accountVerification n/a n/a
Input (group) input n/a n/a
Auto Pay Reference Start Date autoPayReferenceStartDate Optional Used to check if the account has existing auto pay enrollments/options. If not supplied, service will look for auto pay enrollments) as of the current date.
Auto Pay Reference End Date autoPayReferenceEndDate Optional Used to check if the account has existing auto pay enrollments/options.
Custom Inputs (group) customInput Optional Not used in CCB base logic. For implementation use only.
Field 1 field1 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 2 field2 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 3 field3 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 4 field4 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 5 field5 n/a n/a
Name name n/a n/a
Value value n/a n/a
Output output n/a n/a
Is Verified isVerified n/a Boolean
Account Balance accountBalance n/a n/a
Past Due Amount pastDueAmount n/a n/a
Due Date dueDate n/a n/a
Auto Pay Exists autoPayExists n/a Boolean
Existing Account Auto Pay n/a n/a n/a
InformationList (group) existingAccountAutoPayInformation n/a n/a
Auto Pay Start Date autoPayStartDate n/a n/a
Auto Pay End Date autoPayEndDate n/a n/a
Auto Pay Source autoPaySource n/a n/a
Custom Outputs (group) customOutput n/a Not used in CCB base logic. For implementation use only.
Field 1 field1 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 2 field2 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 3 field3 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 4 field4 n/a n/a
Name name n/a n/a
Value value n/a n/a
Field 5 field5 n/a n/a
Name name n/a n/a
Value value n/a n/a
Error Information (group) errorInformation n/a n/a
Is In Error isInError n/a Boolean
Error Reference (group) errorReference n/a n/a
Message Category category n/a n/a
Message Number number n/a n/a
Error Message Text errorMessage n/a n/a
n/a n/a n/a n/a
n/a n/a n/a n/a
n/a n/a n/a n/a