Payment Cancellation Request and Response - Tags in XML Format
Note: We recommend you to refer the Payment Cancellation Request in XML Format and Payment Cancellation 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-CancelPaymentService business service through an inbound web service, you need to ensure that the cancel payment service contains the following tags:
| Tag Name | Tag Description | Mandatory (Yes or No) |
|---|---|---|
| cancelReason | Used to specify the reason for canceling the payments and tenders. | Yes |
| cancelTypeFlag | Used to indicate the type of cancelation. The valid values
are:
|
Yes |
| paymentEventId | Used to specify the payment event id using which you want to cancel the payments and tenders. | Yes (Conditional) Note: This data is required if you have
selected the type of cancelation as Tender Cancel.
|
| paymentId | Used to specify the payment Id using which you want to cancel the payment. | Yes (Conditional) Note: This data is required while canceling
the payment.
|
| bank | Used to indicate the bank which should be charged for the cancellation of the payment. | No |
| bankAccount | Used to indicate the bank account which should be charged for the cancellation | No |
| sourceSystem | Used to indicate the external system from where the create payment request is received. | No |
| externalTransactionId | Used to indicate the external transaction Id of the payment on the payment upload interface. | No |
| externalSourceId | Used to specify the external source system Id. | No |
The following table lists and describes the tags which appear in the payment cancellation response in the XML format:
| Tag | Tag Description |
|---|---|
| paymentsDtls | Displays the payment details. |
| paymentEventId | Displays the payment event Id. |
| paymentId | Displays the payment Id. |
| paymentStatus | Indicates the status of the payment. The valid values are:
|
| messageValue | Indicates an error that occurred while canceling the payment. Note: This tag appears when the value in the statusCd tag is set to Fail.
|
| statusCd | Indicates whether the payment cancellation request is successfully
processed or not. The valid values are:
|
| paymentStatusDesc | Indicates the reason why the cancel payment operation is rejected. |
Related Topics
| For more information on... | See... |
|---|---|
| Sample Payment Cancellation Request and Response in XML Format | Sample Payment Cancellation Request and Response in XML Format |