CancelAPPayment

About CancelAPPayment

This API attempts to cancel a specific bill payment. Payments can only be cancelled if the following conditions are met.

• The payment needs to be an online payment that is not yet processed.
• The call must be made before 2 PM PT of the business day and before the payment process date.

If the deadline has passed, the payment has started processing and you can not cancel the payment. In this situation, use the VoidAPPayment API.

Example

Request

<API_URL_EndPoint>/CancelAPPayment.json

data = {
   "sentPayId" : "stp01FWVZFXERSXCfa2o"
}

Response

{
   "response_status" : 0,
   "response_message" : "Success",
   "response_data" : {
      "entity" : "SentPay",
      "id" : "stp01FWVZFXERSXCfa2o",
      "processDate" : "2016-11-13",
      "amount" : 11.00,
      "status" : "3",
      "description" : "test 2",
      "txnNumber" : "QNGPIACQPCOROCGOLBYE",
      "name" : "P13061901 - 0840029",
      "vendorId" : "00901FCUDTUVOHUFg7jr",
      "isOnline" : true,
      "paymentType" : "0",
      "chartOfAccountId" : "0ca01DDWAORSGOYX5hr5",
      "syncReference" : null,
      "toPrintCheck" : false,
      "createdTime" : "2016-11-19T22:46:44.693+0000",
      "updatedTime" : "2016-11-19T22:46:45.614+0000",
      "bankAccountId" : "bac01BFJWRRGGATS9lyk",
      "billPays" : [ {
         "entity" : "BillPay",
         "id" : "blp01SCVBEJJIUBSi066",
         "billId" : "00n01DYCNSZKWCZWfxbe",
         "name" : "P13061901 - 0840029",
         "paymentStatus" : "2",
         "amount" : 11.00,
         "description" : "test 2",
         "processDate" : "2013-06-13",
         "createdTime" : "2016-11-19T22:46:55.000+0000",
         "updatedTime" : "2016-11-19T22:46:55.000+0000",
         "paymentType" : "1",
         "syncReference" : null,
         "toPrintCheck" : false,
         "chartOfAccountId" : "0ca01DDWAORSGOYX5hr5"
      } ],
      "billCredits" : [ {
         "entity" : "BillCredit",
         "id" : "bcr01FUAGSBMFVCONgo2",
         "billId" : "00n01DYCNSZKWCZWfxbe",
         "sentPayId" : "stp01FWVZFXERSXCfa2o",
         "vendorCreditId" : "vcr01HESIVFKLJBD2oou",
         "amount" : 13.00,
         "createdTime" : "2016-11-19T22:46:54.000+0000",
         "updatedTime" : "2016-11-19T22:46:55.000+0000"
      } ]
      "voidRequest" : {
         "requestedBy" : "00601ANZISORZPERFc7f",
         "voidRequestType" : "1",
         "reason" : "This was a duplicate payment.",
         "createdTime" : "2016-11-19T22:46:54.000+0000",
         "updatedTime" : "2016-11-19T22:46:54.000+0000"
      }
   }
}

Resources

• Payment Management
• VoidAPPayment

Parameters