AutoPay View Request and Response - Tags in XML Format

Note: We recommend you to refer the AutoPay View Request in XML Format and AutoPay View Response in XML Format topics in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the XML format.

Before calling the C1-ViewAutoPayService business service, you need to ensure that the autopay view request contains the following tags:

Tag Name Tag Description Mandatory (Yes or No)
division Used to indicate the division to which the account belongs.
Note: You must specify the division code which is already defined in the system.
 Yes (Conditional)
Note: This data is required while adding or updating the autopay details of an account.
accountId Used to indicate the account for which the autopay details are added or updated.
Note: You must specify the accountId which is already defined in the system.
 Yes (Conditional)
Note: This data is required if accountIdentifierType and accountNumber is not specified.
accountIdentifierType Used to specify the account identifier type.
Note: You must specify an account identifier type which is already defined in the system.
 Yes (Conditional)
Note: This data is required while deleting the auto pay details of an account.
accountNumber Used to indicate the account for which you want to create or update the autopay information. Yes (Conditional)
Note: This data is required when the accountIdentifierType is specified.
StartDate Used to indicate the date from when the autopay is effective for an account. No
AutopaySource Used to specify the autopay source from where the auto pay information is received for an account. No
sourceSystem Used to indicate the external system from where the autopay information is received. No
c1ExternalTransactionId Used to indicate the transaction in the external source system from where the autopay information is received. No
externalSourceId Used to specify the external source system Id. No
accountautopaydata Used to specify a list of autopay details for an account. No
accountId Used to indicate the accountId No
accountAutoPayId Used to specify the autopay Id for an account.
Note: The accountAutoPayId is provided as an input parameter whenever the autopay details are either updated or deleted for an account.
 No
startDate Used to indicate the date from when the autopay is effective for an account.
Note: The startDate cannot not be later than the endDate.
 No
endDate Used to indicate the date till when the autopay is effective for an account.
Note: The startDate cannot not be earlier than the endDate.
 No
autopaySource Used to indicate the source of funds used to make the automatic payment. For example, debit card or credit card.
Note: You must specify the autopaySource which is already defined in the system.
 No
percent Used to indicate the percentage in which the payment must be split between two or more autopay sources having the same priority. No
priorityNum Used to indicate the priority in which the autopay request should be considered when multiple auto pay requests are effective on the bill's due date.
Note: You must specify the priorityNum which is already defined in the system without the occurrence of a decimal.
 Yes
expiresOn Used to specify the date when the autopay source will expire. No
externalAccountId Used to indicate the account in the external system for which the auto pay details should be added or updated. Yes
autopayMaxWithdrawalAmount Used to specify the maximum amount that can be automatically debited from the autopay account. It is used to set the limit on the withdrawal amount.
Note: The autopay max withdrawal amount must be a positive number with or without a decimal. It should not be less than zero.
 No
autoPayMethod Used to indicate how you want to process the autopay request. The valid values are:

  • C1DD - Indicates that you want to directly debit the main customer's bank account.

  • C1PA - Indicates that you want to send a payment advice to the main customer.

Note: You must specify the autopay method which is already defined in the system.
 No
entityName Used to specify the name of the person. No
comments Used to specify additional information about the autopay instruction. No
accountautopaymentchar Used to specify a list of autopay characteristics for an account. No
accountAutoPayId2 Used to specify the autopayId for an account.
Note: The accountAutoPayId is provided as an input parameter whenever the auto pay details are either updated or deleted for an account.
 No
characteristicType You must specify a characteristic type where the characteristic entity is set to Account.
Note: You must specify the characteristic type which is already defined in the system.
 No
sequence Used to indicate the sequence in which the autopay requests must be executed. No
characteristicValue Used to specify the value for the characteristic type. No

The following table lists and describes the tags which appear in the autopay view response in the XML format:

Tag Name Tag Description
accountautopayid Displays the accountautopayid of the account.
response Displays the complete autopay details of the account.
statusCd Indicates whether the autopay viewing request is successfully processed or not. The valid values are:

  • Success

  • Fail
messageText Indicates an error that occurred while viewing the autopayIds.
Note: This tag appears when the value in the responseStatus tag is set to Fail.

Related Topics

For more information on... See...
Sample AutoPay View Request and Response in XML Format Sample AutoPay Add/Update Request and Response in XML Format