AutoPay Deletion Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer the AutoPay Deletion Request in JSON Format and AutoPay Deletion Response in JSON Format topics in
parallel while understanding the below mentioned attributes. This
will help you to understand how the attribute/value pairs are structured
in the JSON format.
Before calling the C1-DeleteAutoPayService business service, you need to ensure that the autopay deletion request contains the following attributes:
| Attribute Name | Attribute 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 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.
|
| 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 auto pay details of an account.
|
| accountId | Used to indicate the account for which the auto pay 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 auto pay information is received. | No |
| c1ExternalTransactionId | Used to indicate the transaction in the external source system from where the auto pay information is received. | No |
| externalSourceId | Used to specify the externalSourceId. | No |
| accountautopaydata | Used to specify a list of autopay details for an account. | No |
| accountAutoPayId | 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 |
The following table lists and describes the attributes which appear in the autopay deletion response in the JSON format:
| Attribute Name | Attribute 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 adding/updating an
autopay request. Note: This attribute appears when the value in the responseStatus attribute is set to Fail.
|
Related Topics
| For more information on... | See... |
|---|---|
| Sample AutoPay Deletion Request and Response in JSON Format | AutoPay Deletion Request in JSON Format |