Payment View Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer thePayment View Request in JSON Format and Payment View Response in JSON Format topics in parallel
while understanding the below mentioned attributes. This will help
you to understand how the attributes are nested in the XML format.
Before calling the C1-ViewPaymentService business service through an inbound web service, you need to ensure that the payment view request contains the following attributes:
| Attribute Name | Attribute Description | Mandatory (Yes or No) |
|---|---|---|
| accountIdentifierType | Used to specify the account identifier type. | Yes (Conditional) Note: This data is required while viewing
the payment history for an account.
|
| accountNumber | Used to specify the value for the account identifier type
of the payee. Note: You must specify the account number which is already
defined in the system.
|
Yes (Conditional) Note: This data is required if the accountIdentifierType is specified.
|
| accountId | Used to indicate the account for which the adjustment history
is retrieved. Note: You must specify an accountId which is already
defined in the system.
|
Yes (Conditional) Note: This data is required if the accountIdentifierType and accountNumber is not specified.
|
| tenderType | Used to indicate the tender type using which you want to
view the payment for an account. Note: You must indicate the tender
type which is already defined in the application.
|
No |
| checkNumber | Used to specify the check number, if payment is made through check. | No |
| division | Used to indicate the division code. Note: You must specify
the division code which is already defined in the system.
|
Yes (Conditional) Note: This data is required while viewing
the payment history for an account.
|
| payDateFrom | Used to specify the date from when the payment is effective
for an account. Note: The payDateFrom cannot not be later than the
paymentDateTo.
|
No |
| paymentDateTo | Used to specify the date till when the payment is effective
for an account. Note: The payDateFrom cannot not be earlier than the
paymentDateTo.
|
No |
| sourceSystem | Used to indicate the external system from where the view payment request is received. | No |
| c1ExternalTransactionId | Used to indicate the external transaction Id of the payment. | No |
| externalSourceId | Used to specify the external source system Id. | No |
The following table lists and describes the attributes which appear in the payment view response in the JSON format:
| Attribute Name | Attribute Description |
|---|---|
| getPayHistResponse | Displays the response returned by the business service in relation to the payment history. |
| statusCd | Indicates whether the view payment request is successfully
processed or not. The valid values are:
|
| messageText | Indicates the reason for an error occurrence. |
| payHistList | Displays the list of payment details for an account. |
| paymentEventId | Displays the payment event ID. |
| paymentId | Displays the payment ID whose payment history is viewed. |
| paymentDate | Displays the date when the payment was made. |
| paymentAmount | Displays the payment amount. |
| paymentStatus | Indicates the status of the payment. The valid values are:
|
| matchType | Indicates the match type using which the payment history is matched. |
| matchValue | Indicates the entity (bill ID or contract ID) against which the payment history is matched. |
| currency | Indicates the currency in which the payment was made. |
| cancelReason | Indicates the reason why the payment was canceled. |
| matchTypeDescription | Indicates the description of the match type. |
| paymentStatusDesc | Indicates the description of the payment status. |
Related Topics
| For more information on... | See... |
|---|---|
| Sample Payment View Request and Response in JSON Format | Sample Payment View Request and Response in JSON Format |