Payment Cancellation Request and Response - Tags in JSON Format

Note: We recommend you to refer the Payment Cancellation Request in JSON Format and Payment Cancellation 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-CancelPaymentService business service, you need to ensure that the cancel payment service contains the following attributes:

Attribute Name Attribute 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:

  • Tender Cancel

  • Payment Cancel

 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 provides information about the response attribute in the cancel payment business service:

Attribute Name Attribute Description
paymentsDtls Displays the payment details.
paymentEventId Displays the payment event Id.
paymentId Displays the payment Id.
paymentStatus Indicates the status returned by the cancel payment business service. The valid values are:

  • Frozen

  • Error
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:

  • Success

  • Fail
paymentStatusDesc Indicates the reason why the cancel payment is rejected.

Related Topics

For more information on... See...
Sample Payment Cancellation Request and Response in JSON Format Sample Payment Cancellation Request and Response in JSON Format