AutoPay View Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer the AutoPay View Request in JSON Format and AutoPay View 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-ViewAutoPayService business service, you need to ensure that the autopay view request contains the following attributes:
| Attribute Name | Attribute Description | Mandatory (Yes or No) |
|---|---|---|
| schema | Used to specify the tags of the cancel adjustment inbound web service. | Yes |
| 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.
|
| 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 auto pay information. | Yes (Conditional) Note: This data is required when the accountIdentifierType is specified.
|
| StartDate | Used to indicate the date from when the auto pay 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 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 external source system Id. | No |
| accountautopaydata | Used to specify a list of auto pay details for an account. | No |
| accountId | Used to indicate the accountId | No |
| accountAutoPayId | Used to specify the auto pay 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 |
| startDate | Used to indicate the date from when the auto pay 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 auto pay 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 auto pay sources having the same priority. | No |
| priorityNum | Used to indicate the priority in which the auto pay 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 auto pay 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 auto pay account. It is used to set the limit on
the withdrawal amount. Note: The auto pay 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 automatic payment
request. The valid values are:
Note: You must specify the auto pay 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 auto pay instruction. | No |
| accountautopaymentchar | Used to specify a list of auto payment characteristics for an account. | No |
| accountAutoPayId2 | Used to specify the auto pay 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 |
| 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 auto pay requests must be executed. | No |
| characteristicValue | Used to specify the value for the characteristic type. | No |
The following table lists and describes the attributes which appear in the autopay view response in the JSON format:
| Attribute Name | Attribute Description |
|---|---|
| accountautopayid | Displays the accountautopayid of the account. |
| response | Displays the complete autopay details of the account. |
| statusCd | Indicates the status returned by the business service. The
valid values are:
|
| messageText | Indicates an error that occurred while viewing the autopayIds. Note: This attribute appears when the value in the responseStatus attribute is set to Fail.
|
Related Topics
| For more information on... | See... |
|---|---|
| Sample AutoPay View Request and Response in JSON Format | Sample AutoPay View Request and Response in JSON Format |