Void Payment

Voids a given payment. When you void a payment, Civic Platform decreases the total payment amount and then increases the balance owed, as if you never made the payment.

Resource Information

Scope payments
App Type Agency
Authorization Type Access token
URI /v4/payments/{paymentId}/void?lang={lang}
HTTP Method PUT
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
lang String No Indicates the language applied. 9.0.0
paymentId string Yes Get All Payments for Record The unique Id generated for a payment. 9.0.0
comments string No   Comments or notes about the void payment transaction. 9.0.0
reason reason{} No   Contains the void payment reason. 9.0.0
reason.text string No   The localized display text. 9.0.0
reason.value string No   The reason for voiding the payment. 9.0.0

Example

Sample Request Head

PUT https://apis.accela.com/v4/payments/3100600/void

Sample Request Body

{
  "reason": {
    "value": "Invalid payment",
    "text": "Invalid payment"
  },
  "comments": "The payment was entered incorrectly."
}

Response Information

Field Type Description Automation Version
result result{} Contains any error related to the transaction 9.0.0
result.code string An error code encountered during the transaction. 9.0.0
result.id string The payment id. 9.0.0
result.isSuccess boolean Indicates whether or not the operation on the item is successful. 9.0.0
result.message string A text message related to the operation. 9.0.0
status integer The request status. 9.0.0

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "id": 3100600,
    "isSuccess": true
  }
}