AutoPay Add/Update Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer the AutoPay Add/Update Request in JSON Format andAutoPay Add/Update 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-AddUpdateAutoPayService business service, you need to ensure that the autopay add/update service 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 adding
or updating the autopay details of an account.
|
accountNumber | Used to indicate the account for which you want to add 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 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 autopay details are
updated or deleted for an account.
|
No |
startDate | Used to indicate the date from when the autopay option is
effective. Note: The startDate cannot not be later than the endDate.
|
Yes |
endDate | Used to indicate the date till when the autopay option is
effective. 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.
|
Yes |
autopayRouteType | Used to indicate when and how automatic payment request of
the account is routed to a financial institution. Note: You must specify
an auto pay route type which is already defined in the system.
|
Yes |
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 autopay instruction
should be considered when multiple auto pay instructions 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 |
expirationMonth | Used to specify the month when the autopay source will expire. Note: The expiration month should not be earlier than the month of the
start date.
|
No |
expirationYear | Used to specify the year when the autopay source will expire. Note: The expiration year should not be earlier than the year of the start
date.
|
No |
externalAccountId | Used to indicate the account in the external system for which the autopay details should be added or updated. | Yes |
entityName | Used to specify the name of the person. | No |
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 |
comments | Used to specify additional information about the autopay instruction. | No |
autoPayMethod | Used to indicate how you want to process the automatic payment
request. The valid values are:
Note: You must specify the autopay method which is already defined
in the system.
|
No |
accountautopaymentchar | Used to specify a list of autopay characteristics 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 |
characteristicValue | Used to specify the value for the characteristic type. | No |
The following table lists and describes the attributes which appear in the autopay add/update response in the JSON format:
Attribute Name | Attribute Description |
---|---|
responseStatus | Indicates whether the autopay add/update request is successfully
processed or not. The valid values are:
|
responseMessage | Indicates an error that occurred while conducting an add/update
of an autopay request. Note: This attribute appears when the value
in the responseStatus tag is set to Fail.
|
Related Topics
For more information on... | See... |
---|---|
Sample AutoPay Add/Update Request and Response in JSON Format | Sample AutoPay Add/Update Request and Response in JSON Format |