Void Payment
The following endpoint can be used to void a Payment within the Hyfin application.
Endpoint
The following endpoint can be used to void a Payment. You must replace the {base_url} and {site_id} variables with the appropriate values.
POST
{base_url}/api/v3/site/{site_id}/Payment/void
Request
Field
Type
Required
Description
id
String
The payment id.
reason
String
--
Optional reason for the void.
Sample Request
{
"id": "64fa4489fb1eaa8e5ae93475"
}
Response
Field
Type
Description
success
Boolean
Whether the void processed successfully.
errors
String [ ]
A list of errors. Will only be returned if `success` is `false`.
Sample Response (Successful)
{
"success": true
}
Sample Response (Failed)
{
"success": false,
"errors": [
"NO PAYMENT FOUND",
"Payment not voidable"
]
}