Void Payment

Use this to cancel a payment before it settles, usually the same day it was made.

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.1/site/{site_id}/payment/void
Request
Field
Type
Description
id
String
The payment id. A void cancels the whole payment before it settles, so no money moves. When the processor refuses the void, such as after the payment settles, the request fails. It never falls back to a refund. The payment must be paid and processed by us, and a payment takes one refund or void in total.
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.
			
{
  "success": true
}


		

Related