AutoPay Deletion Request and Response - Tags in XML Format
Note: We recommend you to refer the AutoPay Deletion Request in XML Format and AutoPay Deletion 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-DeleteAutoPayService business service, you need to ensure that the autopay deletion request contains the following tags:
| Tag Name | Tag Description | Mandatory (Yes or No) |
|---|---|---|
| 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 autopay 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.
|
| 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.
|
| 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 |
| accountAutoPayId | Used to specify the autopay Id 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 |
The following table lists and describes the tags which appear in the autopay deletion response in the XML format:
| Tag Name | Tag Description |
|---|---|
| accountautopayid | Displays a list of account autopayIds which are deleted through an autopay deletion request. |
| responseStatus | Indicates whether the autopay deletion request is successfully
processed or not. The valid values are:
|
| responseMessage | Indicates an error that occurred while deleting 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 Deletion Request and Response in XML Format | Sample AutoPay Deletion Request and Response in XML Format |